Documentation module:Boîte d'informations (Configuration)

De Encyclopédie francophone de la Roue du Temps
Aller à la navigation Aller à la recherche

Ceci est la page de documentation pour Module:Boîte d'informations (Configuration)

Le module Module:Boîte d'informations (Configuration) contient la configuration liée au module Boîte d'informations. Les paramètres communs et spécifiques des boîtes d'informations sont définis.

Groupes d'éléments

Il est possible de créer différent types de groupe d'éléments, le plus commun étant la liste qui est défini comme celui par défaut. Les groupes d'éléments possèdent les propriétés communes suivantes.

Propriété Type Description
title Facultatif Titre du groupe
type Facultatif, list par défaut Type du groupe

Liste

Les listes sont définies par le type list ou en omettant le type. Il faut alors définir une propriété items contenant la liste d'éléments à ajouter aux groupes. Chaque élément doit et peut contenir les propriétés suivantes.

Propriété Type Description
key Obligatoire La clé à utiliser pour la construction du modèle.
title Obligatoire Titre de l'élément de liste qui sera affiché à gauche.
description Factultatif Description de l'élément à utiliser lors de la construction de la documentation.

Chaque liste d'éléments aura une propriété libre ajoutée automatiquement formatée de la façon suivante :

Propriété Description
libellé libre # Titre de l'élément.
valeur libre # Valeur de l'élement.

Texte libre

Les textes sont définies par le type free et utilisent du wikitexte.

Groupes d'icônes

Les groupes d'icônes, définis par le type iconsList, sont une liste de liens mis en place sur des icônes de Font Awesome.

Références