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

Un livre de Wikilivres.
Contenu supprimé Contenu ajouté
Aucun résumé des modifications
m Formatage, ajout de code
 
Ligne 15 : Ligne 15 :
== Espace de nom et utilisation des modèles ==
== Espace de nom et utilisation des modèles ==


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


Les pages qui utilisent le modèle emploient la syntaxe des double-accolades pour encadrer le nom du modèle.
Les pages qui utilisent le modèle emploient la syntaxe des double-accolades pour encadrer le nom du modèle.
Ligne 24 : Ligne 24 :
! Contenu de la page
! Contenu de la page
|-
|-
| <tt>Modèle:Bienvenue</tt>
| <code>Modèle:Bienvenue</code>
Cette page de modèle contient un texte de bienvenue.
Cette page de modèle contient un texte de bienvenue.
| <tt>Bienvenue sur Wikilivres ...</tt>
| <code>Bienvenue sur Wikilivres ...</code>
|-
|-
| <tt>Discussion Utilisateur:Moi</tt>
| <code>Discussion Utilisateur:Moi</code>
Cette page utilise le modèle pour souhaiter la bienvenue à l'utilisateur.
Cette page utilise le modèle pour souhaiter la bienvenue à l'utilisateur.
| <tt><nowiki>{{Bienvenue}}</nowiki></tt>
| <code><nowiki>{{Bienvenue}}</nowiki></code>
|}
|}


Si le modèle n'appartient pas à l'espace de nom dédié <tt>Modèle</tt>, 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).
Si le modèle n'appartient pas à l'espace de nom dédié <code>Modèle</code>, 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 :
Exemples :
Ligne 52 : Ligne 52 :
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.
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 :
Exemple : Utiliser le modèle <code>Cadre</code> avec les arguments suivants :
* paramètre numéro 1 : <tt>Une bonne remarque</tt>
* paramètre numéro 1 : <code>Une bonne remarque</code>
* paramètre <tt>couleur fond</tt> : <tt>#eef</tt>
* paramètre <code>couleur fond</code> : <code>#eef</code>
<nowiki>{{</nowiki>Cadre|Une bonne remarque|couleur fond=#eef<nowiki>}}</nowiki>
<nowiki>{{</nowiki>Cadre|Une bonne remarque|couleur fond=#eef<nowiki>}}</nowiki>
Ce qui donne comme résultat :
Ce qui donne comme résultat :
Ligne 62 : Ligne 62 :
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.
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) :
Exemple : Pour le modèle <code>Cadre</code> (version simplifiée pour l'exemple) :
<nowiki><div style="width:auto;clear:both;margin:.5em 0em; padding:.5em;
<nowiki><div style="width:auto;clear:both;margin:.5em 0em; padding:.5em;
border:1px solid #A0A0A0;
border:1px solid #A0A0A0;
Ligne 75 : Ligne 75 :
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.
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 :
Exemple : Modèle <code>Cadre</code> avec valeurs par défaut pour les paramètres :
<nowiki><div style="width:auto;clear:both;margin:.5em 0em; padding:.5em;
<nowiki><div style="width:auto;clear:both;margin:.5em 0em; padding:.5em;
border:1px solid #A0A0A0;
border:1px solid #A0A0A0;
Ligne 85 : Ligne 85 :
</div></nowiki>
</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.
Dans cet exemple, la valeur par défaut du paramètre <code>couleur fond</code> est <code>auto</code>, celle du paramètre numéro 1 est vide.


== Modèles plus complexes ==
== Modèles plus complexes ==
Ligne 93 : Ligne 93 :
=== Substitution ===
=== Substitution ===
L'utilisation d'un modèle avec les double-accolades ne remplace pas dans la page appelante les double-accolades par le contenu du modèle.
L'utilisation d'un modèle avec les double-accolades ne remplace pas dans la page appelante les double-accolades par le contenu du modèle.
Pour effectuer cette substitution, il suffit de placer le mot <tt>subst:</tt> avant le nom du modèle :
Pour effectuer cette substitution, il suffit de placer le mot <code>subst:</code> avant le nom du modèle :
<nowiki>{{subst</nowiki>:Cadre|Une bonne remarque|couleur fond=#eef<nowiki>}}</nowiki>
<nowiki>{{subst</nowiki>:Cadre|Une bonne remarque|couleur fond=#eef<nowiki>}}</nowiki>


Ligne 108 : Ligne 108 :
La balise &lt;includeonly&gt; est utilisée pour contenir le modèle lui-même et éviter son affichage quand la documentation est visualisée.
La balise &lt;includeonly&gt; est utilisée pour contenir le modèle lui-même et éviter son affichage quand la documentation est visualisée.


Exemple : Pour le modèle <tt>Cadre</tt> vu précédemment :
Exemple : Pour le modèle <code>Cadre</code> vu précédemment :
<nowiki><includeonly><div style="width:auto;clear:both;margin:.5em 0em; padding:.5em;
<nowiki><includeonly><div style="width:auto;clear:both;margin:.5em 0em; padding:.5em;
border:1px solid #A0A0A0;
border:1px solid #A0A0A0;

Version actuelle du 22 juillet 2017 à 22:21

Consultez également ces pages dans d’autres projets Wikimedia :

Ressources multimédia sur Commons.
Article encyclopédique sur Wikipédia.
Définition sur Wiktionnaire.
Ressources éducatives sur Wikiversité.
Texte sur Wikisource.
Citations sur Wikiquote.
Article d’actualité sur Wikinews.
Coordination des projets sur Meta-Wiki.

Pour Mediawiki, les modèles sont des pages dont le contenu est inclus dans les pages appelantes. Un modèle peut servir, entre autres 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[modifier | modifier le wikicode]

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[modifier | modifier le wikicode]

Beaucoup de modèles utilisent des paramètres. Les paramètres permettent de spécifier certaines fonctionnalités 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[modifier | modifier le wikicode]

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é[modifier | modifier le wikicode]

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é[modifier | modifier le wikicode]

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.

Modèles plus complexes[modifier | modifier le wikicode]

Les sections précédentes ont expliquées le fonctionnement de base des modèles. Cette section aborde des fonctionnalités plus complexes.

Substitution[modifier | modifier le wikicode]

L'utilisation d'un modèle avec les double-accolades ne remplace pas dans la page appelante les double-accolades par le contenu du modèle. Pour effectuer cette substitution, il suffit de placer le mot subst: avant le nom du modèle :

{{subst:Cadre|Une bonne remarque|couleur fond=#eef}}

Après sauvegarde de la page, les double-accolades sont remplacées par le contenu du modèle appelé. Il n'est donc plus possible de retrouver la syntaxe d'appel au modèle.

Inclusion / non-inclusion[modifier | modifier le wikicode]

Les modèles disposent de deux balises spéciales dont le contenu est inclus ou pas selon le contexte :

  • <noinclude> : le contenu ne doit pas être inclus quand le modèle est appelé. Il n'est affiché que si le modèle est accédé directement comme une page normale.
  • <includeonly> : le contenu doit être inclus quand le modèle est appelé, mais pas affiché quand le modèle est accédé directement comme une page normale.

Les deux balises spéciales ont donc deux comportements complémentaires.

En général, la balise <noinclude> est utilisée pour contenir la documentation du modèle lui-même, et éviter qu'elle ne soit reproduite à l'utilisation du modèle. La balise <includeonly> est utilisée pour contenir le modèle lui-même et éviter son affichage quand la documentation est visualisée.

Exemple : Pour le modèle Cadre vu précédemment :

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

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

     {{{1|}}}

</div></includeonly><noinclude>Ce modèle de cadre utilise
le premier paramètre comme contenu est un paramètre optionnel
nommé "couleur fond" pour spécifier la couleur de fond.</noinclude>

ParserFunctions[modifier | modifier le wikicode]

Pour plus de détails voir : m:ParserFunctions/fr.

Wikipédia propose un article sur : « Aide:Modèle ».

Le Wiktionnaire possède une entrée pour « Aide:Modèle ».

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).