Module:Livre/Documentation

Un livre de Wikilivres.
Aller à la navigation Aller à la recherche
Lua-Logo.svg
Ceci est la sous-page de documentation du module Livre ; elle est insérée automatiquement sur la page de celui-ci par le logiciel Mediawiki. C’est également sur cette page que vous placerez les liens interwiki et les catégories du module.

Ce module fournit les fonctions suivantes :

titleParts( titre[, nombre[, premier]] )
  • Utilisation dans les modèles : {{#invoke:Livre|titleParts|titre|nombre|premier}}
  • Cette fonction est similaire à la parser function {{#titleparts}} à deux choses près : elle tient compte des titres comportant une barre oblique ("/", slash) et le premier caractère du texte renvoyé ne voit pas sa casse modifiée.
  • Alias : titleparts
racine( [titre] )
  • Utilisation dans les modèles : {{#invoke:Livre|racine|titre}}
  • Cette fonction renvoie la racine (la base de toutes les sous-pages) pour le titre donné, ou celui de la page courante si aucun titre n’est donné ; elle tient compte des titres comportant une barre oblique ("/", slash).
  • Alias : root
base()
  • Utilisation dans les modèles : {{#invoke:Livre|base}}
  • Cette fonction renvoie la base du livre dont fait partie la page courante ; les différences avec la fonction racine sont qu’elle inclut une barre oblique ("/") à la fin et qu’elle tient compte des arborescences avec plusieurs livres en sous-pages[1]. Elle ne prend aucun paramètre.
  1. De plus, certains espaces de noms sont traités spécialement.
accueil()
  • Utilisation dans les modèles : {{#invoke:Livre|accueil}}
  • Cette fonction renvoie la page d’accueil du livre dont fait partie la page courante ; la différence avec la fonction base est qu’elle renvoie vers une page (et donc n’inclut pas la barre oblique à la fin). Elle ne prend aucun paramètre.
  • Alias : home