Différences entre versions de « Aide:Modèle »

De Wiki Olydri
Sauter à la navigation Sauter à la recherche
(Page créée avec « Cette page propose quelques explications simples pour comprendre les modèles dans un wiki. Pour avoir des explications plus complètes, consultez la page [http://fr.wiki... »)
 
Ligne 110 : Ligne 110 :
  
 
== Création ou modification d'un modèle ==
 
== Création ou modification d'un modèle ==
 +
 +
=== Partie utile et documentation ===
 +
La plupart des pages de modèle contiennent deux parties :
 +
* une partie utile, qui est le texte inséré dans les pages où le modèle est apposé,
 +
* la documentation du modèle.
 +
 +
Pour définir la partie documentation, qui ne doit pas être insérée dans les autres pages, il faut la délimiter par les balises <code><nowiki><noinclude></nowiki></code> et <code><nowiki></noinclude></nowiki></code>.
 +
 +
Il arrive parfois que l'on ne souhaite pas que la partie utile soit visible dans la page du modèle. C'est le cas où des paramètres sont obligatoires et leur absence donne un rendu inesthétique. Par exemple le modèle {{m|Roman Noob}} sans paramètre donne : {{Roman Noob}}.
 +
 +
Pour éviter cet affichage, il faut utiliser les balises <code><nowiki><includeonly></nowiki></code>et <code><nowiki></includeonly></nowiki></code>. Dans ce cas, il faut prévoir dans la documentation des exemples pour montrer le rendu du modèle.
  
 
=== Paramètres d'un modèle ===
 
=== Paramètres d'un modèle ===
 +
 +
Dans un modèle ses paramètres apparaissent sous la forme <code><nowiki>{{{</nowiki>''nom du paramètre''|''valeur par défaut''<nowiki>}}}</nowiki></code>.
 +
 +
Pour illustrer, voici la partie utile du modèle {{m|Citation}} :
 +
<pre><includeonly>« {{{1|}}} »</includeonly></pre>
 +
Ce modèle s'utilise avec la syntaxe suivante :
 +
<pre>{{Citation|Le texte à citer}}</pre>
 +
 +
Dans l'appel ci dessus, les paramètres sont implicites, il n'y en a qu'un, de nom <code>1</code> qui vaut <code>Le texte à citer</code>.
 +
 +
Le résultat du modèle consiste à mettre ce texte entre guillemets : {{Citation|Le texte à citer}}.
 +
 +
 +
Les paramètres peuvent s'utiliser dans des liens wiki. Le modèle {{m|m}}, qui sert à faire un lien sur un modèle et à le mettre en accolade, a le code suivant (le code est en fait plus complexe, j'ai simplifié pour une meilleure compréhension ; le paramètre est mis en bleu pour une meilleur compréhension) :
 +
<code><nowiki><includeonly>[[Modèle:</nowiki><b><span style="color:#0000ff"><nowiki>{{{1|}}}</nowiki></span></b><nowiki>|{{</nowiki><b><span style="color:#0000ff"><nowiki>{{{1|}}}</nowiki></span></b><nowiki>}}]]</includeonly></nowiki></code>.
 +
 +
 +
Un modèle peut en appeler un autre et même utiliser un paramètre pour sélectionner le modèle appelé. Par exemple, le modèle {{m|Web série Noob}} appelle, en fonction de la saison, l'un des six modèles suivants :
 +
* {{m|Web série Noob/Saison 1}}, pour la première saison
 +
* {{m|Web série Noob/Saison 2}}, pour la seconde saison
 +
* {{m|Web série Noob/Saison 3}}, pour la troisième saison
 +
* {{m|Web série Noob/Saison 4}}, pour la quatrième saison
 +
* {{m|Web série Noob/Saison 5}}, pour la cinquième saison
 +
* {{m|Web série Noob/Saison hors}}, pour les épisodes hors saison
 +
 +
{{m|Web série Noob}} est appelé avec deux paramètres obligatoires, <code>saison</code> et <code>épisode</code>. Il a dans sa partie utile le code : <code><nowiki>{{Web série Noob/Saison {{{saison|}}} | {{{épisode}}} }}</nowiki></code> appel du sous-modèle en fonction de la valeur de saison, avec un paramètre implicite qui est égal à la valeur du paramètre <code>épisode</code>.
 +
 +
=== Les fonctions parser ===

Version du 21 janvier 2014 à 22:46

Cette page propose quelques explications simples pour comprendre les modèles dans un wiki.

Pour avoir des explications plus complètes, consultez la page Aide:Modèle sur Wikipédia.

Définition d'un Modèle

Un modèle est une page du wiki qui est située dans l'espace Modèle:.

Il sert à définir un texte ou une mise en forme qui est reproduite sur différentes pages du wiki.

Utilisation d'un modèle

Pour utiliser un modèle dans une page, il suffit de mettre le nom du modèle, sans le nom de l'espace Modèle: entre une double accolade.

Exemple : lorsque vous voulez séparer deux références contiguës par une virgule en exposant, au lieu de mettre le code <sup>, </sup>, utilisez le modèle Modèle:, qui fait le même chose, en plaçant dans la page ce code {{,}}.

Les paramètres

Un code peut avoir plusieurs paramètres. Il faut mettre la double accolade ouvrante, le nom du modèle, une barre verticale (|), le premier paramètre, une autre barre verticale (|), le deuxième paramètre, et ainsi de suite jusqu'au dernier paramètre, et enfin la double accolade fermante.

Par exemple, si vous voulez mettre une référence sur un épisode de la web série, utilisez le modèle Modèle:Web série Noob, mais ce modèle ne peut pas fonctionner seul, il faut lui préciser la saison et l'épisode. Par exemple, pour l'épisode 7 de la saison, 5, il faut placer {{Web série Noob|saison=5|épisode=7}}, ce qui donne « Phases finales (Saison 5, épisode 7)vidéo ».

Dans l'exemple précédent, les paramètres sont explicites, c'est à dire que leur nom est spécifié : le premier paramètre a pour nom saison et vaut 5, le second a pour nom épisode et vaut 7. Les paramètre peuvent aussi être implicite, dans ce cas il prennent pour nom leur position dans la liste des paramètres.

Par exemple, le modèle Modèle:Exemple. Vous pouvez le placer sans nommer les paramètres {{Exemple|A|B|C|D}}. Les paramètres auront les noms et valeurs suivantes :

  • 1=A
  • 2=B
  • 3=C
  • 4=D


Lorsque les paramètres sont explicite, leur ordre n'est pas important, vous pouvez les inverser sans problème. Ainsi :

  • {{Web série Noob|saison=5|épisode=7}} donne « Phases finales (Saison 5, épisode 7)vidéo ».
  • {{Web série Noob|épisode=7|saison=5}} donne « Phases finales (Saison 5, épisode 7)vidéo », c'est à dire la même chose.

Ce n'est évidemment pas le cas des paramètres implicites, où la position du paramètre dans la liste des paramètres permet de nommer le paramètre.

Enfin, un modèle peut utiliser des paramètres explicites et implicites en même temps. Là encore, la position du paramètre explicite parmi les paramètres implicite n'a pas d'importante :

{{Exemple|A|B|C|D|p=P}} {{Exemple|A|B|C|p=P|D}} {{Exemple|A|B|p=P|C|D}} {{Exemple|A|p=P|B|C|D}} {{Exemple|p=P|A|B|C|D}}
  • 1=A
  • 2=B
  • 3=C
  • 4=D
  • p=P
  • 1=A
  • 2=B
  • 3=C
  • 4=D
  • p=P
  • 1=A
  • 2=B
  • 3=C
  • 4=D
  • p=P
  • 1=A
  • 2=B
  • 3=C
  • 4=D
  • p=P
  • 1=A
  • 2=B
  • 3=C
  • 4=D
  • p=P

Introduire un saut de ligne entre deux paramètres ne pose pas de problème. Ainsi, les deux codes suivant auront le même effet :

{{Infobox personnage non joueur
|nom=Arthéon de Färgoth
|faction=sans
|image=Artheon sourcelame.jpg
|légende=
|taille image=200
|type=pnj
|sous-type=Olydrien
|détail sous-type=World Boss
|lieu de vie=
|classe=[[guerrier]]
|ancien nom=Arthéon
|ancienne guilde=[[guilde Noob]]
|ancienne faction=Empire
|nature=humain
|identité IRL=[[Stanislas Châtelain]]
|statut IRL=salarié de [[Neuropa Entertainment]]
}}

{{Infobox personnage non joueur|nom=Arthéon de Färgoth|faction=sans|image=Artheon sourcelame.jpg|légende=|taille image=200|type=pnj|sous-type=Olydrien|détail sous-type=World Boss|lieu de vie=|classe=[[guerrier]]|ancien nom=Arthéon|ancienne guilde=[[guilde Noob]]|ancienne faction=Empire|nature=humain|identité IRL=[[Stanislas Châtelain]]|statut IRL=salarié de [[Neuropa Entertainment]]}}

Pour une question de lisibilité, la première forme est à préférer.

Quelques modèles utilisables

Modèles de mise en forme Modèle de source Modèle de description d'image Modèles d'infobox

Création ou modification d'un modèle

Partie utile et documentation

La plupart des pages de modèle contiennent deux parties :

  • une partie utile, qui est le texte inséré dans les pages où le modèle est apposé,
  • la documentation du modèle.

Pour définir la partie documentation, qui ne doit pas être insérée dans les autres pages, il faut la délimiter par les balises <noinclude> et </noinclude>.

Il arrive parfois que l'on ne souhaite pas que la partie utile soit visible dans la page du modèle. C'est le cas où des paramètres sont obligatoires et leur absence donne un rendu inesthétique. Par exemple le modèle {{Roman Noob}} sans paramètre donne : Erreur du paramètre 'saison' dans le modèle {{roman Noob}} (paramètre absent ou valeur erronée (seules valeurs permises 1.5, 2.5, 3.5 et 4.5).

Pour éviter cet affichage, il faut utiliser les balises <includeonly>et </includeonly>. Dans ce cas, il faut prévoir dans la documentation des exemples pour montrer le rendu du modèle.

Paramètres d'un modèle

Dans un modèle ses paramètres apparaissent sous la forme {{{nom du paramètre|valeur par défaut}}}.

Pour illustrer, voici la partie utile du modèle {{Citation}} :

<includeonly>« {{{1|}}} »</includeonly>

Ce modèle s'utilise avec la syntaxe suivante :

{{Citation|Le texte à citer}}

Dans l'appel ci dessus, les paramètres sont implicites, il n'y en a qu'un, de nom 1 qui vaut Le texte à citer.

Le résultat du modèle consiste à mettre ce texte entre guillemets : « Le texte à citer ».


Les paramètres peuvent s'utiliser dans des liens wiki. Le modèle {{m}}, qui sert à faire un lien sur un modèle et à le mettre en accolade, a le code suivant (le code est en fait plus complexe, j'ai simplifié pour une meilleure compréhension ; le paramètre est mis en bleu pour une meilleur compréhension) : <includeonly>[[Modèle:{{{1|}}}|{{{{{1|}}}}}]]</includeonly>.


Un modèle peut en appeler un autre et même utiliser un paramètre pour sélectionner le modèle appelé. Par exemple, le modèle {{Web série Noob}} appelle, en fonction de la saison, l'un des six modèles suivants :

{{Web série Noob}} est appelé avec deux paramètres obligatoires, saison et épisode. Il a dans sa partie utile le code : {{Web série Noob/Saison {{{saison|}}} | {{{épisode}}} }} appel du sous-modèle en fonction de la valeur de saison, avec un paramètre implicite qui est égal à la valeur du paramètre épisode.

Les fonctions parser