Help:Templates/fr

Si vous avez des textes standards que vous voulez inclure sur plusieurs pages, les modèles (templates) de MediaWiki peuvent vous aider. À la différence des extensions et des fichiers multimédia, il n'y a pas de lieu centralisé pour le stockage des modèles. Les modèles peuvent être écrits ex nihilo ou bien, pour récupérer un travail déjà effectué, ils peuvent être exportés d'un autre wiki (par exemple Wikipédia) puis importés dans le wiki cible.

Création
Les modèles sont des pages wiki standard dont le contenu est conçu pour être transclus (inclus) à l'intérieur d'autres pages. Par convention le nom des modèles doit avoir le préfixe " ", qui l'assigne à cet espace de noms en plus de cela, vous pouvez  les créer comme n'importe quelle autre page wiki.

L'utilisation la plus simple des modèles est la suivante. Si vous créez une page nommée « Template:Bienvenue » avec pour contenu :

Bonjour ! Bienvenue sur le wiki.

vous aurez créé votre premier modèle ! Si vous insérez ensuite le code :

sur n'importe quelle autre page, le texte "Bonjour ! Bienvenue sur le wiki." apparaîtra à la place de  quand cette page sera visualisée. Le contenu du modèle est « transclus » dans l'autre page, c'est-à-dire qu'il est intégré dans la page.

Vous pouvez ensuite insérer  à n'importe quel endroit de n'importe quelle page où vous voulez souhaiter la bienvenue à quelqu'un. Supposez qu'il soit utilisé dans 100 pages. Si vous changez ensuite le contenu du modèle par :

Salut ! Bienvenue sur ce merveilleux wiki.

et si vous revisitez n'importe laquelle des 100 pages où le modèle est utilisé, vous verrez le nouveau texte à la place de l'original. De cette façon, vous avez changé le contenu de 100 pages sans les avoir éditées, parce que le modèle est transclus dans ces pages.

C'est le mécanisme de base. Plusieurs fonctionnalités supplémentaires de transclusion enrichissent ce mécanisme et rendent les modèles très utiles.

Utilisation
Les modèles peuvent être utilisés dans d'autres pages de plusieurs manières :


 * : comme montré plus haut, ce lien est remplacé de manière dynamique par le contenu de la page "Template:Nom du modèle" en cours au moment où la page avec le lien est chargée. Mais le lien reste inchangé dans la page source.
 * — avec cette notation, le lien est remplacé une fois pour toutes par le contenu de la page Template:Nom du modèle au moment où vous enregistrez la page avec le lien : une copie du contenu de Template:Nom du modèle sera insérée à la place du lien vers le modèle. Le contenu du modèle devient alors un élément à part entière de la page qui l'inclut, et peut être modifié normalement, indépendamment de l'original.;
 * — ceci a été introduit pour tenir compte des substitutions qui ne rompent pas la transclusion. Voir The safesubst: modifier.
 * inclut le modèle dans un formulaire qui l'affiche comme de la syntaxe brute wiki (comme le fait ) quand la page qui le contient est récupérée.

En fait, une page ordinaire du wiki peut être utilisée comme un modèle, simplement en spécifiant l'espace de nom où elle se trouve, et donc :


 * inclut
 * inclut
 * inclut
 * est remplacé par le contenu de

Si un tel espace de noms n'existe pas, le titre complet est considéré comme étant un modèle :


 * inclut

Paramètres
Pour enrichir le mécanisme de transclusion, Mediawiki permet de passer des paramètres à un modèle lorsqu'il est transclus. Les paramètres permettent au modèle d'afficher des contenus différents ou d'avoir des comportements différents.

Supposons que vous vouliez insérer une petite note de remerciement sur la page de discussion d'autres utilisateurs, comme ceci :

La note de remerciement contiendra la raison du remerciement (dans ce cas, tous tes efforts) et une signature (Moi). Votre but est que tout utilisateur soit capable de remercier tout autre utilisateur, quel qu'en soit le motif.

Pour que la note ait la même apparence partout où elle est utilisée, vous pouvez définir un modèle appelé, par exemple. Bien que la note doive avoir la même apparence à chaque fois qu'un utilisateur remercie un autre utilisateur, son contenu spécifique (c'est à dire la raison et la signature) sera différent. Pour cela, vous devez les passer en tant que paramètres. Si on omet les autres éléments de mise en forme de la boîte et de l'image, le contenu principal du modèle sera celui-ci :

Notez l'utilisation de  et. C'est la manière d'identifier, à l'intérieur du modèle, les paramètres qui lui sont passés lorsqu'il sera utilisé. Notez qu'à l'intérieur du modèle chaque paramètre est encadré par trois accolades :. Cela diffère de l'utilisation normale d'un nom de modèle.

Quand vous utilisez le modèle sur une page, vous complétez les valeurs des paramètres, séparés par un caractère "pipe". MediaWiki permet la transmission des paramètres aux modèles selon trois manières : anonymement, numéroté, et nommé.

Paramètres anonymes
Pour passer des paramètres anonymes, listez les valeurs de ces paramètres de manière séquentielle :

Dans ce cas, le modèle  reçoit les paramètres   et , ce qui produit :

L'ordre de passage des paramètres anonymes est crucial pour le comportement du modèle. Inverser l'ordre des paramètres, comme ceci :

produirait ce résultat :

Paramètres numérotés
Pour passer des paramètres numérotés, identifiez chaque paramètre quand vous le passez :

Cette fois, le modèle  reçoit comme paramètres   et , même s'ils ont été fournis dans l'ordre inverse, et produit le résultat :

Paramètres nommés
La troisième façon de passer des paramètres est d'utiliser des noms, à la place de nombres. Dans ce cas, le contenu du modèle deviendrait :

Un petit remerciement... pour. bises,

Dans le modèle, on utilise  et   pour identifier chaque paramètre, au lieu des numéros. Pour passer ces paramètres par leur nom, identifiez chaque paramètre lorsque vous le passez :

Dans ce cas, le modèle  reçoit les paramètres   et   et produit le résultat :

Les paramètres nommés sont sensibles à la casse, donc :

produit :

L'avantage d'utiliser des paramètres nommés dans votre modèle, en plus d'apporter une flexibilité quant à l'ordre dans lequel on peut passer les paramètres, est que le code du modèle est beaucoup facile à comprendre s'il y a beaucoup de paramètres.

Valeurs par défaut
Si vous incluez un modèle qui attend des paramètres, mais sans lui fournir leurs arguments, comme ici :

dans l'exemple des paramètres numérotés ci-dessus vous obtiendriez ce qui suit :

À partir du moment où aucun argument n'a été passé au modèle, ce dernier affiche les paramètres eux-mêmes, au lieu de leurs valeurs respectives. Dans ce cas, il serait plus utile de définir des valeurs "par défaut" pour les paramètres, c.à.d des valeurs qui seront utilisées si aucune valeur n'est fournie. Par exemple, si le contenu du modèle est changé pour :

alors  définit que si aucun argument n'est fourni pour le paramètre , alors la valeur  sera utilisée. De même, le paramètre  fait que la valeur par défaut de   est. Maintenant, inclure le modèle à nouveau et sans passer d'argument donnera le résultat suivant :

Often default values are used to specify alternate names of parameters. For example, if you have, the template will first look for a parameter named "a". If it is not set, it will use the parameter named "b". If neither "a" nor "b" is set, it will output nothing.

Evaluation
Generally speaking, template parameters are substituted into the template after tokenization, but as is. They are not evaluated until they are used.

This has a few consequences. First of all, if you have a  containing , and a   containing  , and put   on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. You can still use templates to control the name of a parameter or template, but you cannot split a template call amongst multiple templates.

The second consequence of this is dead-code elimination. If you make a template call like, and Template:Foo does not contain  , then the displaytitle is not used, since it is only evaluated when needed, and it there is no parameter to substitute it into, so it is never evaluated. This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the  magic word that varies by user language.

Template calls starting with the magic word  or   are evaluated in a separate first pass that only happens at save time, along with ~ and links using the pipe trick. If they cannot be evaluated during the first pass, subst: calls are ignored, and safesubst: are treated as if a normal template.

Many but not all parser functions, parser tags and trancluded special pages are not directly included like templates but instead are replaced by a "strip marker". This means you cannot manipulate the results with parser functions like padleft: or similar functions from extensions, as they see the strip marker instead of the result of the parser function.

Récursivité dans les modèles
Appeler un modèle à partir de lui-même ne bloquera pas MediaWiki sur une récursion infinie. MediaWiki arrêtera la récursivité au modèle dont le nom figure en gras. Par exemple, si le contenu de "Template:Aaaa" est " ", il sera montré "Template:Aaaa" et affichera Template loop detected:  Template:Aaaa.

Contrôler l'inclusion des modèles
Par défaut, le contenu d'un modèle est affiché intégralement, qu'il soit affiché directement ou qu'il soit inclus dans une autre page. Cependant, vous pouvez contrôler quelle partie du modèle sera vue et incluse en utilisant les balises,   et.

Tout ce qui est contenu entre  et   est affiché uniquement sur la page du modèle lorsqu'elle est affichée directement, mais pas lorsqu'elle sera incluse dans une autre page. Ceci est utile lorsque vous désirez inclure du texte ou du code dans un modèle, sans que ces éléments ne soient propagés sur les pages appelant le modèle, comme par exemple :


 * liens de catégorie pour la catégorisation du modèle lui-même
 * des liens interwikis pour les modèles similaires dans d'autres langues
 * texte d'explication sur l'utilisation du modèle

De manière équivalente, tout ce qui est contenu entre  et   sera pris en compte et affiché uniquement quand la page est incluse, et non pas quand la page du modèle est affichée directement, ceci est utile dans des situations telles que :


 * la catégorisation des pages qui incluent le modèle. Remarque : quand vous modifiez de cette manière les catégories appliquées à un modèle, la catégorisation des pages qui incluent ce modèle peut ne pas être mise à jour immédiatement. Ceci est géré par la . Pour forcer la re-catégorisation d'une page particulière, ouvrez cette page pour la modifier et enregistrez-la sans rien changer.
 * le fait de s'assurer que le code du modèle n'est pas exécuté lors de la lecture de la page même du modèle. Habituellement, c'est parce que ce code attend des paramètres et que son exécution sans paramètres produit un résultat inattendu.

Tout ce qui est en dehors des balises  et   est pris en compte et affiché normalement, que ce soit sur la page même du modèle qui est affiché, ou sur une page où ce modèle est inclus. Le focus concerne ce qui se trouve entre ces deux balises.

Tout ce qui se trouve à l'extérieur des balises   n'est pas pris en compte pour l'inclusion. Même les sections balisées includeonly sont exclues de l'inclusion à moins qu'elles ne soient également balisées onlyinclude. Le focus concerne ce qui se trouve à l'extérieur de cette balise.

Il est aussi possible d'imbriquer ces balises.

Les trois balises d'inclusion partielles autorisent toutes les combinaisons possibles de ce qui est traité et mis en forme. Les commentaires jouent aussi un rôle.

Organiser les modèles
Pour que les modèles soient utiles, les utilisateurs doivent les trouver et savoir comment les utiliser.

Pour les trouver, les utilisateurs peuvent :
 * 1) cliquer sur ' > '
 * 2) dans la liste des ', choisir Modèle et cliquer sur '.

Pour donner des informations sur l'utilisation, incluez un exemple comme celui-ci sur la page du modèle :

Utilisation
Remercier les utilisateurs :

Ainsi, un utilisateur peut simplement copier et coller l'exemple pour utiliser le modèle.

Faire un lien vers un modèle
Il est possible de faire un lien vers une page de modèle comme pour n'importe quelle autre page du wiki. Par exemple, le lien est généré en utilisant le code wiki.

Sur de nombreux wikis, le modèle Template:Tl peut être utilisé pour fournir un lien vers un modèle, mis en forme d'une manière qui montre le code avec les "double accolades" qui est nécessaire pour transclure le modèle, sans effectuer réellement la transclusion. Par exemple, le code  peut être utilisé pour créer le lien Navbar.

Cette construction est couramment utilisée dans les pages de documentation des modèles, sur les pages d'aide, et sur les pages de discussion lorsqu'il est fait référence aux modèles. Le même objectif peut être atteint avec le code, mais l'approche utilisant le modèle tl est plus simple à saisir au clavier. Sur n'importe quel wiki, le modèle Tl, s'il est défini, peut normalement effectuer un rendu du texte encadré par des balises « code », comme montré ici. Si ce n'est pas le cas, il devrait exister un autre modèle avec un nom similaire pour réaliser la même chose. Voir, par exemple, la section « Voir aussi » dans la documentation du modèle en:Template:Tl sur la Wikipédia en anglais. The same effect can be achieved by using, but the tl approach involves much less typing. On any given wiki the Tl template, if it exists, may or may not render the text in a "code" element, as shown here. If not, another similarly named template may do so. See, for example, the "See also" section of the documentation of en:Template:Tl at the English Wikipedia.

Copier d'un wiki à l'autre
Les modèles requièrent parfois du CSS ou d'autres modèles, les utilisateurs ont parfois des problèmes lorsqu'ils copient les modèles d'un wiki à un autre. Les étapes ci-dessous doivent fonctionner avec la plupart des modèles :

Code MediaWiki
Si vous avez les droits d'importation (et en particulier ) sur le wiki cible :


 * 1) Allez à Special:Export sur le wiki original, et téléchargez un fichier .XML avec l'historique complet de tous les modèles nécessaires, comme ceci :
 * 2) * Entrez le nom du modèle dans la grande zone de texte, par exemple "Modèle:Bienvenue". Faites très attention à la casse et aux caractères spéciaux - si le nom du modèle n'est pas correctement entré, l'export aura bien lieu mais le fichier .XML ne contiendra pas les données attendues.
 * 3) * Cochez la case « ».
 * 4) * Décochez la case .
 * 5) * Cliquez sur « ».
 * 6) Allez à Special:Import sur le nouveau wiki et téléversez le fichier XML.

Si vous n'avez pas les droits d'importation sur le wiki cible :


 * 1) Allez sur le modèle que vous voulez copier sur le wiki source. Allez sur la page de modification, et copier tout le code wiki.
 * 2) Sur le nouveau wiki, allez sur la page de même nom que celui du modèle que vous avez copié. Cliquer sur créer ou modifier et coller le code copié. Dans le résumé d'édition de chaque modèle, liez à la page originale pour l'attribution des droits.
 * 3) De retour sur le wiki original, en dessous de la boîte d'édition, regardez la liste des modèles utilisés dans cette page. Pour chaque modèle listé, suivez ces mêmes instructions d'importation. Ainsi que pour les modèles utilisés par ces modèles, et ainsi de suite.

Cette procédure va copier entièrement le code nécessaire, et sera suffisante pour certains modèles. Si ça ne marche pas, vérifiez aussi qu'il n'y a pas de liens rouges sous pages incluses dans la version actuelle de cette page, au dessous de la boîte d'édition. Si il y en a, répétez les étapes ci-dessus pour chacun des liens corrigés.

Après avoir importé correctement le modèle et ses modèles liés depuis d'autres wikis, modifiez-le pour le personnaliser et l'adapter à votre wiki. Par exemple pour changer un logo, pour enlever les catégories redondantes ou faire disparaître les liens rouges.

Extensions
ParserFunctions est une extension souvent utilisée dans les modèles. Allez sur et vérifiez si, parmi les fonctions affichées, certaines sont utilisées dans les modèles que vous avez copiés. Si c'est le cas, vous devez installer l'extension. Pour l'installer, vous avez besoin de l'accès administrateur système au serveur de votre instance de MediaWiki.

Une autre dépendance qui peut être utilisée dans les modèles, notamment ceux de Wikipédia, est Lua. La présence de   dans le code des modèles est un bon indice de son utilisation. Dans le cas où il est utilisé, vous devez installer l'extension et il faut avoir également l'accès administrateur. Voir cette page pour les instructions détaillées concernant l'installation et l'usage de l'extension.

Code CSS et JavaScript
En plus du code MediaWiki, beaucoup de modèles font usage du CSS et certains emploient le JavaScript pour fonctionner. Si les modèles copiés n'ont pas le comportement attendu, cela pourrait venir de cela. Pour copier le CSS et le JavaScript requis sur votre wiki, vous devez normalement avoir besoin des droits d'administrateur, car vous aurez à éditer les messages système dans l'espace de noms « MediaWiki: ».


 * 1) Recherchez l'utilisation de classes CSS dans le texte de votre modèle (ex :  ). Si ces classes apparaissent dans  « MediaWiki:Common.css » ou  « MediaWiki:Monobook.css » sur le wiki d'origine, copiez-les dans  « MediaWiki:Common.css » sur le nouveau wiki et vérifiez si le modèle fonctionne mieux.
 * 2) Si le modèle copié ne fonctionne toujours pas comme prévu, vérifier s'il y a du code dans « MediaWiki:Common.js » ou « MediaWiki:Monobook.js » sur le wiki d'origine. Si c'est le cas, vous pouvez essayer de le copier dans « MediaWiki:Common.js » sur le nouveau wiki. Normalement, le mieux serait de copier seulement le code issu de sources fiables, et de parcourir d'abord le code pour identifier et sélectionner les parties pertinentes. Vous devriez trouver des commentaires qui peuvent vous servir d'indice pour identifier la fonction de chaque partie.

Voir aussi

 * - exemple d'utilisation spéciale des modèles.
 * – trucs et astuces que vous pourriez rencontrer dans certains modèles.
 * – autres fonctions de contrôle pratiques comme #if et #switch
 * – règles sur l'utilisation des fonctions de l'analyseur dans les modèles
 * m:Aide:Modèle – manuel plus approfondi sur le fonctionnement exact des modèles.
 * m:Aide:Modèles avancés – des techniques encore plus avancées telles que l'appel de modèles dynamiques et des noms variables de paramètres.
 * m:Aide:Pages inclues – inclure des pages depuis des espaces de noms autres que.
 * Manual:Creating pages with preloaded text – Using templates as the starting text of a page
 * Manual:Creating pages with preloaded text – Using templates as the starting text of a page
 * Manual:Creating pages with preloaded text – Using templates as the starting text of a page
 * Manual:Creating pages with preloaded text – Using templates as the starting text of a page
 * Manual:Creating pages with preloaded text – Using templates as the starting text of a page

Liens externes

 * Dépôt des modèles Miraheze - Modèles MediaWiki à usage général.