Modèle:Contenu de sommaire/Créer un style

À proposlink={{{link}}}

Cette page explique comment créer un nouveau style de sommaire / de navigation. Ces informations seront également utiles pour l’édition de styles existants ; notez cependant que ces styles sont susceptibles d’être utilisés sur de nombreuses pages, dont l’aspect risque d’être modifié, et dont la mise à jour consommera une certaine quantité de ressources des serveurs...

Fonctionnement

modifier

Le modèle {{Contenu de sommaire}} (ou {{Chapitres}}) est utilisé sur la page de sommaire du livre (la sous-page /Sommaire), cette page étant appelée par le modèle {{Sommaire}} ou {{Navigation}} avec un paramètre style normalement transmis à {{Contenu de sommaire}} (si les recommandations ont été suivies).

Ensuite, le modèle {{Contenu de sommaire}}[1] va inclure la page de style autant de fois qu’il y a de chapitres et de sous-titres, plus une fois au début, une fois à la fin, et une fois à chaque changement de niveau (sous-chapitres), et ce éventuellement plusieurs fois si le style nécéssite plusieurs passes.

  1. au travers de la fonction Lua contenuDeSommaire du module Navigation.

Paramètres

modifier

La page de style (personnalisée ou générale) est donc un modèle ; voici les paramètres qu’elle recevra :

{{{partie}}}
  • début : au début de chaque passe,
  • fin : à la fin de chaque passe,
  • chapitre : pour chaque chapitre,
  • sous-titre : pour chaque sous-titre,
  • début de liste : lorsqu’on monte d’un niveau,
  • fin de liste : lorsqu’on redescend d’un niveau,
  • passes : si un nombre est renvoyé lors de la partie passes, toute la série d’appels sera répété pour atteindre ce nombre de fois.
{{{passe}}}
le numéro de la passe en cours (1 pour la première, et éventuellement la seule).
{{{option ...}}}
(... étant le nom de l’option) options telles que données à {{Contenu de sommaire}}.
{{{livre}}}
le titre du livre.
{{{accueil}}}
la page d’accueil du livre.
{{{sommaire}}}
la page de sommaire du livre.
{{{niveau}}}
le niveau de sous-chapitre (1 au départ).
{{{chapitre}}}
le nom du chapitre.
{{{page}}}
la page du chapitre.
{{{numéro}}}
le numéro du chapitre.
{{{sous-titre}}}
le sous-titre (défini pour la partie sous-titre, ainsi que pour le chapitre qui suit).
{{{image}}}
l’image pour le chapitre, si elle a été donnée.
{{{avancement}}}
l’état d’avancement du chapitre, s’il a été donné.
{{{auto}}}
défini à auto s’il s’agit d’un lien automatiquement ajouté par {{Contenu de sommaire}}.
{{{précédent}}}
le nom du chapitre précédent (non défini s’il n’y en a pas).
{{{page précédent}}}
la page du chapitre précédent (non défini s’il n’y en a pas).
{{{suivant}}}
le nom du chapitre suivant (non défini s’il n’y en a pas).
{{{page suivant}}}
la page du chapitre suivant (non défini s’il n’y en a pas).
{{{parent}}}
le nom du chapitre de niveau supérieur (non défini au niveau 1).
{{{page parent}}}
la page du chapitre de niveau supérieur (non défini au niveau 1).

Exemples

modifier

N’hésitez pas à aller voir les styles existants pour vous aider.