« Aide:Modèles » : différence entre les versions

Un livre de Wikilivres.
Contenu supprimé Contenu ajouté
Nouvelle version de la page d'aide
Ligne 30 : Ligne 30 :


== Modèles paramétrés ==
== Modèles paramétrés ==
Beaucoup de modèles utilisent des paramètres. Les paramètres permettent de spécifier certaines fonctionnalité d'un modèle, ce qui permet d'utiliser les modèles pour autre chose que du texte fixe. Par exemple, un modèle de cadre peut accepter un contenu wiki et une couleur de fond.


=== Type de paramètres ===
<!-- À compléter -->
Il existe deux types de paramètres :
* '''les paramètres ordonnés''' : ils sont numérotés à partir de 1, et ne possède pas de nom,
* '''les paramètres nommés''' : ils possèdent un nom.

=== Appel à un modèle paramétré ===
La liste des arguments assignés aux paramètres du modèle doivent être spécifiés à l'intérieur des accolades, après le nom du modèle. Chaque paramètre est séparé du précédent et du nom du modèle par une barre verticale.

Pour les paramètres ordonnés, il suffit de spécifier la valeur de l'argument. Les arguments des paramètres nommés doivent être précédés du nom associé et du signe égal ; de plus, ils doivent être placés de préférence après les paramètres ordonnés.

Exemple : Utiliser le modèle <tt>Cadre</tt> avec les arguments suivants :
* paramètre numéro 1 : <tt>Une bonne remarque</tt>
* paramètre <tt>couleur fond</tt> : <tt>#eef</tt>
<nowiki>{{</nowiki>Cadre|Une bonne remarque|couleur fond=#eef<nowiki>}}</nowiki>
Ce qui donne comme résultat :
{{Cadre|Une bonne remarque|couleur fond=#eef}}

=== Créer un modèle paramétré ===
Le contenu du modèle utilise une syntaxe spéciale pour remplacer les paramètres par leur valeur au moment de l'utilisation du modèle : le numéro ou le nom du paramètre doit être encadré par des triple-accolades.

Exemple : Pour le modèle <tt>Cadre</tt> (version simplifiée pour l'exemple) :
<nowiki><div style="width:auto;clear:both;margin:.5em 0em; padding:.5em;
border:1px solid #A0A0A0;

background-color:{{{couleur fond}}};">

{{{1}}}

</div></nowiki>

Il est également possible de spécifier des valeurs par défaut quand le paramètre peut être omis.
La valeur par défaut est spécifiée dans les triple-accolades, après le nom/numéro du paramètre et une barre verticale.

Exemple : Modèle <tt>Cadre</tt> avec valeurs par défaut pour les paramètres :
<nowiki><div style="width:auto;clear:both;margin:.5em 0em; padding:.5em;
border:1px solid #A0A0A0;

background-color:{{{couleur fond|auto}}};">

{{{1|}}}

</div></nowiki>

Dans cet exemple, la valeur par défaut du paramètre <tt>couleur fond</tt> est <tt>auto</tt>, celle du paramètre numéro 1 est vide.


== Voir aussi ==
== Voir aussi ==

Version du 23 juillet 2007 à 00:00

Pour Mediawiki, les modèles sont des pages dont le contenu est inclus dans les pages appelantes. Un modèle peut servir, entre autre choses, à :

  • contenir un texte répété en plusieurs endroits d'une page, d'un livre ou de plusieurs livres, et donc centraliser des contenus utiles,
  • mettre en forme et présenter un texte, un code source, une remarque ... uniformément dans tous les livres.

Espace de nom et utilisation des modèles

Un modèle appartient en règle général à l'espace de nom Modèle consacré aux modèles.

Les pages qui utilisent le modèle emploient la syntaxe des double-accolades pour encadrer le nom du modèle.

Exemple :

Nom de la page Wiki et description Contenu de la page
Modèle:Bienvenue

Cette page de modèle contient un texte de bienvenue.

Bienvenue sur Wikilivres ...
Discussion Utilisateur:Moi

Cette page utilise le modèle pour souhaiter la bienvenue à l'utilisateur.

{{Bienvenue}}

Si le modèle n'appartient pas à l'espace de nom dédié Modèle, comme par exemple le sommaire d'un livre, il est possible de faire appel à ce modèle en spécifiant l'espace de nom auquel il appartient (espace de nom vide s'il s'agit du principal).

Exemples :

{{Wikilivres:Copyright}}
{{:Renaissance et Réforme/Sommaire}}

Modèles paramétrés

Beaucoup de modèles utilisent des paramètres. Les paramètres permettent de spécifier certaines fonctionnalité d'un modèle, ce qui permet d'utiliser les modèles pour autre chose que du texte fixe. Par exemple, un modèle de cadre peut accepter un contenu wiki et une couleur de fond.

Type de paramètres

Il existe deux types de paramètres :

  • les paramètres ordonnés : ils sont numérotés à partir de 1, et ne possède pas de nom,
  • les paramètres nommés : ils possèdent un nom.

Appel à un modèle paramétré

La liste des arguments assignés aux paramètres du modèle doivent être spécifiés à l'intérieur des accolades, après le nom du modèle. Chaque paramètre est séparé du précédent et du nom du modèle par une barre verticale.

Pour les paramètres ordonnés, il suffit de spécifier la valeur de l'argument. Les arguments des paramètres nommés doivent être précédés du nom associé et du signe égal ; de plus, ils doivent être placés de préférence après les paramètres ordonnés.

Exemple : Utiliser le modèle Cadre avec les arguments suivants :

  • paramètre numéro 1 : Une bonne remarque
  • paramètre couleur fond : #eef
{{Cadre|Une bonne remarque|couleur fond=#eef}}

Ce qui donne comme résultat :

Une bonne remarque

Créer un modèle paramétré

Le contenu du modèle utilise une syntaxe spéciale pour remplacer les paramètres par leur valeur au moment de l'utilisation du modèle : le numéro ou le nom du paramètre doit être encadré par des triple-accolades.

Exemple : Pour le modèle Cadre (version simplifiée pour l'exemple) :

<div style="width:auto;clear:both;margin:.5em 0em; padding:.5em;
     border:1px solid #A0A0A0;

     background-color:{{{couleur fond}}};">

     {{{1}}}

</div>

Il est également possible de spécifier des valeurs par défaut quand le paramètre peut être omis. La valeur par défaut est spécifiée dans les triple-accolades, après le nom/numéro du paramètre et une barre verticale.

Exemple : Modèle Cadre avec valeurs par défaut pour les paramètres :

<div style="width:auto;clear:both;margin:.5em 0em; padding:.5em;
     border:1px solid #A0A0A0;

     background-color:{{{couleur fond|auto}}};">

     {{{1|}}}

</div>

Dans cet exemple, la valeur par défaut du paramètre couleur fond est auto, celle du paramètre numéro 1 est vide.

Voir aussi

Voici quelques liens utiles à propos des modèles :

  • Wikilivres:Modèles recense les modèles utilisables, leur documentation est plus détaillée sur la page du modèle lui-même,
  • Special:ExpandTemplates réservée aux créateurs de modèles, cette page spéciale permet de tester l'expansion de modèles (source et résultat).