Différences entre les versions de « Modèle:Contenu de sommaire/Documentation »

Aller à la navigation Aller à la recherche
Nouvelle version de {{Contenu de sommaire}}
(+ {{Documentation de modèle}})
(Nouvelle version de {{Contenu de sommaire}})
__NOTOC__<noinclude>{{Documentation de modèle}}</noinclude>
== Utilisation ==
Ce modèle permet de créer un '''sommaire''' pour un livre.
(par exemple : <code>''Livre de ceci cela/Sommaire''</code>),
et ainsi l’afficher automatiquement grâce au modèle {{m|Sommaire}}.
Il peut fonctionner en mode simple ou complexe.
 
Ce modèle est aussi disponible en tant que {{m|Chapitres}}.
 
===Mode simpleSyntaxe===
<nowiki>{{</nowiki>Contenu de sommaire | style = <nowiki>{{{</nowiki>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, modèlede tags html,&nbsp;...).
 
Le titre du chapitre peut être suivi des champs suivants :
===Mode complexe===
* l’état d’avancement du chapitre (nombre entre 0 et 100),
<nowiki>{{</nowiki>Contenu de sommaire | complexe = 1 | style = <nowiki>{{{</nowiki>style|''autre''}}}
* une image illustrant le chapitre ;
| ''ext''/''Chapitre 2''/''params'' | ''ext''/''Chapitre 2''/''params'' | ... }}
ces informations pourront être utilisés par le style (dépend du style).
La syntaxe du mode complexe est identique au mode simple, sauf qu’on utilise le paramètre <code>complexe</code> (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 :
<nowiki>{{</nowiki>Contenu de sommaire | complexe = 1 | style = <nowiki>{{{</nowiki>style|''autre''}}}
* le nom de l’extension
| ''Chapitre 1'' | ''avancement 1'' | [<nowiki/>[Image:''une_image'']]
* ensuite le titre du chapitre (comme le mode simple)
| ''Chapitre 2'' | ''avancement 2'' | [<nowiki/>[Image:''autre_image'']] | ... }}
* enfin la liste des paramètres de l’extension séparés par des barres obliques (''{{lang|en|slash}}'', « / »)
 
<u>Note:</u> 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).
Attention: chaque élément est séparé des autres par une barre oblique et non par une barre verticale.
 
===Niveaux et titres===
Voyez la [[Spécial:Index/Modèle:Contenu de sommaire/Extension|page de l’extension]] pour en savoir plus sur les paramètres.
Il est possible de faire des sous-chapitres en faisant précéder le nom du chapitre par autant de signes ''plus'' (<code>+</code>) 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 (<code>!</code>).
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 <code><nowiki>{{{</nowiki>style|''autre''}}}</code> pour <!--
--> pouvoir définir le style à partir du modèle {{m|Sommaire}} ; <!--
--> ''autre'' (peut être vide) permet de décider quel style utiliser lorsqu’il n’est pas <!--
--> pas défini par <nowiki>{{</nowiki>Sommaire}} (mettezvous celuipouvez lemettre pluspar employé).<br>exemple celui qui est <!--
--> Si le styleplus n’estemployé). pasAttention: donnévous lorsdevez deici l’appelutiliser àle <nowiki>{{</nowiki>Contenu depréfixe ''sommaire}},'' ou ''navigation''.<br> <!--
--> Si le style n’est pas donné lors de l’appel à <nowiki>{{</nowiki>Contenu de sommaire}}, <!--
--> le style ''[[Modèle:Contenu de sommaire/Style par défaut|par défaut]]'' sera utilisé : <!--
--> c’est normalement une redirection vers un autre style.<br> <!--
--> Note: le style ''[[Modèle:Contenu de sommaire/Style sommaire personnalisé| 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 <!--
; titre : Certains styles permettent de définir le titre du sommaire ; vous pouvez utiliser <!--
--> valeurs reconnues pour ce paramètre sont : ''oui'', ''true'', ''1'', ''non'', ''false'' et ''0''.
--> <code><nowiki>{{</nowiki>BASEPAGENAME}}</code> comme valeur pour avoir le titre du livre.
 
; liens automatiques : Permet de gérer l’ajout automatique des liens ''Glossaire'', ''Auteurs'', <!--
; image : Certains styles permettent d’afficher une image (écrivez le nom du fichier ''sans le préfixe'').
--> ''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.
 
; option1,option option2,... option3<br/> option ...<nowiki>:</nowiki> ''style'', option4... : Certains styles acceptent des options ; voyez <!--
--> voyez la [[{{Lien interne|Spécial:Index/Modèle:Contenu de sommaire/Style|q=stripprefix=1|page du style]]}} pour en savoir plus.<!--
--> pour en savoir plus. La seconde version permet de n’appliquer l’option qu’à certains styles.
 
; base : Pour indiquer l’emplacement du livre (n’est utile que si le livre n’est pas à la racine ; <!--
--> voir aussi {{m|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 <!--
--> [[mw:Help:Extension:ParserFunctions#.23titleparts|fonction #titleparts]]).
 
== Exemples ==
 
<nowiki>{{</nowiki>Contenu de sommaire
| style = <nowiki>{{{</nowiki>style|[[Modèle:Contenu de sommaire/Style sommaire large|sommaire large]]}}}
| Les carrés rouges
| Les ronds bleus
 
<nowiki>{{</nowiki>Contenu de sommaire|
complexe=1| style=<nowiki>{{{</nowiki>style|[[Modèle:Contenu de sommaire/Style sommaire large|sommaire large]]}}}|
[[Modèle:Contenu| de sommaire/Extension avancement|avancement]]/Les carrés rouges/5 | 5
[[Modèle:Contenu| de sommaire/Extension avancement|avancement]]/Les ronds bleus/33 | 33
[[Modèle:Contenu de sommaire/Extension avancement|avancement]]/ Les triangles verts/ | 100
}}
 
<nowiki>{{</nowiki>Contenu de sommaire
| complexe=oui | style=<nowiki>{{{</nowiki>style|[[Modèle:Contenu de sommaire/Style sommaire bas|sommaire bas]]}}}
| option1=option numéros seuls = 1
| option titre =<nowiki>{{{</nowiki>BASEPAGENAME}}} ~ | option image = Wikibooks-logo-fr.png |
| Pommes
| Poires | [<nowiki/>[Image:Wikibooks-logo-fr.png]]
| super extension/Poires/x/y/z
| Ananas
|| 133
| autre extension / Pêches / 5326
| Pêches
| extension sans paramètre/Abricots
}}
 
== Voir aussi ==
* le modèle {{m|Sommaire}} qui permet d’inclure automatiquement le sommaire créé ;
* le modèle {{m|Navigation}} qui utilise également le sommaire créé ;
* la [[Spécial:Index/Modèle:Contenu de sommaire/Style|liste des styles disponibles]]
* la [[{{Lien interne|Spécial:Index/Modèle:Contenu de sommaire/ExtensionStyle|q=stripprefix=1|liste des extensionsstyles disponibles]]}}.
 
<noinclude>[[Catégorie:Documentations des modèles]]</noinclude>

Menu de navigation