Aide:Modèles

De 24 Wiki FR

Si vous avez des textes standards que vous souhaitez inclure dans plusieurs pages, c'est alors que la fonctionnalité modèle entre en jeu.

Création d'un modèle

Les noms des modèles sont précédés du préfixe ou espace de nom Modèle: (ou Template: en anglais, valable aussi sur les wikis français). Vous pouvez les créer comme n'importe quelle autre page wiki.

Utilisation d'un modèle

Les modèles sont des pages wiki qui peuvent être utilisées dans d'autres pages de trois manières différentes :

  • {{Nom}} inclut le contenu du modèle à l'endroit de la page où il est positionné est appelé "[[Modèle:Nom]]".
  • {{subst:Nom}} insère tout le contenu du modèle dans le code de la page et "[[Modèle:Nom]]" devient de ce fait modifiable directement après avoir publié votre texte. Si vous modifiez le modèle, la page contenant ce dernier inséré de la sorte ne sera pas modifiée.
  • {{msgnw:Nom}} quand la page contenant ce modèle est appelée, cela inclut le modèle dans un formulaire qui l'affiche sous forme de syntaxe wiki brute du type <nowiki>

Utilisation de paramètres au sein d'un modèle

Modèle avec des paramètres numérotés
 
'''Un petit merci...'''<br />
<small>pour {{{1}}}.<br />
Salutations, {{{2}}}</small>
Vous tapez Vous obtenez
{{Merci|tout le travail accompli|Joe}}
Image exemple
Un petit merci...
pour tout le travail accompli.
Salutations, Joe
 
'''Un petit merci...'''<br />
<small>pour {{{raison}}}.<br />
Salutations, {{{signature}}}</small>
Vous tapez Vous obtenez
{{Merci
|raison = tout le travail accompli
|signature = Joe}}
Image exemple
Un petit merci...
pour tout le travail accompli.
Salutations, Joe

Vous pouvez définir des paramètres dans les modèles soit sous forme de numéro {{{1}}} ou bien portant un nom comme {{{param}}}.

Exemple : vous voulez créer une petite note de remerciement que vous souhaitez mettre sur la page de discussion d'autres utilisateurs. Elle contiendra une raison et votre signature. Vous pouriez créer Modèle:Merci pour entrer votre texte, comme dans l'exemple montré dans le tableau de droite.

Quand vous utilisez le modèle sur une page, vous le remplissez avec les valeurs de paramètres séparés d'une barre verticale (|) : {{Merci|tout le travail accompli|Joe}}. Pour les paramètres nommés, utilisez les paires «  » séparées par une barre verticale : {{Merci |raison = tout le travail accompli |signature = Joe}}. L'avantage d'utiliser les paramètres avec nom dans votre modèle est que l'ordre des paramètres n'a pas d'importance. Il facilite aussi la compréhension du modèle s'il contient plusieurs paramètres. Si vous voulez changer l'ordre des paramètres sous forme de numéro, vous devez les mentionnez explicitement : {{Merci|2=Joe|1=tout le travail accompli}}.

Vous pouvez aussi donner des valeurs par défaut à vos paramètres, c'est-à-dire des valeurs qui seront utilisées si aucune valeur n'est entrée pour un paramètre donné. Par exemple {{{raison|tout le travail accompli}}} aurait pour résultat « tout le travail accompli » si aucune valeur n'est entrée pour le paramètre raison.

Contrôle de l'inclusion d'un modèle

Vous pouvez contrôler l'inclusion d'un modèle en utilisant les balises <noinclude> et <includeonly>.

Tout ce qui se trouve entre <noinclude> et </noinclude> sera traité et affiché uniquement si la page est visualisée directement et non si elle est incluse.

Applications possibles :

  • La catégorisation des modèles
  • Les liens interlingue vers des modèles similaires dans d'autres langues
  • Un texte explicatif sur la façon d'utiliser le modèle

L'opposé est <includeonly>. Le texte compris entre <includeonly> et </includeonly> sera traité et affiché seulement dans la page où ce modèle a été inclus. L'application évidente est d’ajouter toutes les pages contenant un modèle donné dans une catégorie sans y mettre le modèle concerné.

Note : quand vous modifiez les catégories appliquées par un modèle, la catégorisation des pages qui utilisent ce modèle peuvent n'être mises qu'un certain temps plus tard : ceci est dû à la file d'attente des travaux, gérée par MediaWiki.

Organisation des modèles

Pour qu'un modèle soit efficace, les utilisateurs doivent pouvoir les trouver facilement et comprendre comment les utiliser. Une technique simple consiste à inclure un exemple dans la page modèle. Par exemple :

<noinclude>
== Utilisation ==

Permet d'établir un lien vers un sujet :
{{Nom du modèle|Terme1+Terme2+Terme3}}
</noinclude>

Dans ce cas, l'éditeur n'aura qu'à faire un copier-coller de l'exemple pour créer une page similaire.

Il est utile de créer une Catégorie:Modèles sur un nouveau wiki afin que tous les modèles puissent être trouvé au même emplacement et que vos utilisateurs puissent les trouver.