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. Parce que l'appel du modèle reste dans le source des pages, toute modification ultérieure faite à Template:Name est vue de la page contenant l'appel du modèle. Egalement, la page sera listée parmis les pages (link to) qui appellent le modèle.
 * — 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. C'est à dire une copie du contenu de Template:Name sera substitué par l'appel du modèle. Aucun lien n'est maintenu entre la page et le modèle, ce qui permet ensuite de les mettre à jour séparément sans interférence. En effet, il existe une petite différence entre substituer le contenu de cette manière et le saisir simplement à la main dans le source de la page.
 * — ceci a été introduit pour permettre la substitution récursive dans les cas où des modèles contiennent des appels à d'autres modèles ou fonctions d'analyse. Voir pour plus d'informations.
 * - ceci présente le modèle de telle manière que le contenu du modèle s’affiche en syntaxe wiki brute (comme le fait ) quand la page qui le contient est visualisé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 :


 * transclut la page nommée Modèle:Nom de page (équivaut à )
 * transclut la page nommée Discussion:Nom de la page
 * 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 :


 * transclut Modèle:Foo:Bar

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 :


 * Exemples :

produit



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 :

Souvent les valeurs par défaut sont utilisées pour préciser les noms alternatifs des paramètres. Par exemple, si vous avez, le modèle cherchera d'abord un paramètre qui s'appelle « a ». S'il n'est pas renseigné, il utilisera le paramètre « b  ». Si ni « a » ni « b » ne sont renseignés, il ne produira rien.

Évaluation
D'une manière générale, les paramètres des modèles sont substitués dans le modèle après l'attribution des marques (tokenization). Ils ne sont pas évalués tant qu'ils ne sont pas utilisés.

Ceci a quelques conséquences. D'abord si vous avez un  contenant , et un   contenant  , et que vous mettez   sur une page, mytemplate ne sera pas transclus car les éléments tels que "|" ne peuvent pas être ajoutés par un modèle et ils conservent leur signification spéciale dans les modèles. Vous pouvez toujours utiliser les modèles pour contrôler le nom d'un paramètre ou du modèle, mais vous ne pouvez pas répartir l'appel d'un modèle sur plusieurs modèles.

La seconde conséquence de ceci est la suppression du code mort. Si vous faites l'appel d'un modèle comme, et que Template:Foo ne contient pas  , alors le displaytitle n'est pas utilisé car il n'est évalué que lorsque c'est nécessaire et qu'ici aucun paramètre ne demande sa substitution, il est donc jamais évalué. Ceci se passe habituellement avec l'extension ParserFunctions, et peut être observé particulièrement quand elle est utilisée en combination avec le mot magique  qui change avec la langue de l'utilisateur.

L'appel aux modèles commençant par le mot magique  ou   est évalué dans une première passe indépendante qui n'apparaît qu'au moment de la sauvegarde, en même temps que ~ et s'enchaîne en utilisant l'astuce des pipes '|'. S'ils ne peuvent pas être évalués durant la première passe, les appels  sont ignorés, et les   sont traités comme pour un modèle normal.

Beaucoup de fonctions de l'analyseur syntaxique (mais pas toutes), de l'analyseur de balises et des pages spéciales transcluses ne sont pas directement incluses comme les modèles mais sont remplacées à la place par une étiquette d'identification (strip marker). Cela signifie que vous ne pouvez pas manipuler les résultats avec les fonctions d'analyse des extensions telles que padleft: ou équivalent, parce qu'elles voient le strip marker au lieu du résultat de la fonction d'analyse.



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é "a a Template loop detected:  Template:Aaaa z z".



Mots interdits
Cette sauvegarde exclut un nom de modèle potentiellement utile où un modèle auto-normalise ses propres arguments d'appel. Dans cet exemple interdit  peut être appelé soit   soit. S'il est appelé de la première façon, il revient sur lui-même avec la deuxième structure d'argument (obtenue à l'aide de fonctions d'analyseur de chaînes), qui suit ensuite un chemin de traitement unifié.



Si  est modifié pour se récurser en   et   est une copie manuelle identique de , cet idiome fonctionne bien car la protection d'auto-récursivité fonctionne de manière dynamique et non statique.

Un moyen possible pour le logiciel MediaWiki d'assouplir la règle d'auto-récursivité serait d'exiger que chaque appel récursif ait un nombre d'arguments distinct de tous les appels actifs précédents, récurrent au plus une fois, avec le nombre d'arguments non décroissant. Cela fournirait une garantie solide contre l'auto-récursivité infinie tout en permettant des idiomes utiles tels que celui décrit ici de manière flexible.

Si la séquence de traitement est de faible complexité, une simple solution en utilisant seulement un seul modèle est de gérer chacune des conventions d'appel dans une branche séparée if/else, en dupliquant la logique du traitement à l'intérieur de chaque cas. Si la séquence de traitement est trop complexe, chaque cas de structure d'appel peut être délégué à un modèle d'implémentation avec une structure d'appel unifiée fournissant le comportement final du modèle.



Tableaux dans les paramètres
Parce que la barre verticale et le signe égal  ont différentes significations dans l'appel des modèles et les tables wiki, pour utiliser le balisage des tables comme valeur de paramètre de modèle, on a généralement recours à l'échappement de ces caractères (pour empêcher qu'ils ne soient interprétés comme balisage du modèle) en utilisant des séquences spéciales :


 * le embarqué   fournit une version échappée de   depuis MediaWiki 1.24
 * le mot magique embarqué  fournit une version échappée de   depuis MediaWiki 1.39

Avant l'introduction de ces mots magiques, beaucoup de wikis utilisaient les modèles pour accomplir les mêmes choses. Sur un tel wiki, les mots magiques prévalent sur les modèles ayant le même nom.



Tableau d'exemple
Code de la table :

Code échappé, de la table :

Notez que la première accolade ouvrante est interprétée comme un caractère littéral parce qu'elle est immédiatement suivie du mot magique. De manière équivalente, la dernière accolade fermante et interprétée comme un caractère littéral car elle est immédiatement précédée du même mot magique. Néanmoins, dans certains cas ces caractères accolades causent réellement des problèmes, et quelques wikis fournissent des modèles pour échapper ces caractères, comme :


 * l'appel du modèle  pourrait fournir une version échappée de
 * l'appel du modèle  pourrait fournir une version échappée de

Certains wikis vont même plus loin et fournissent d'autres modèles pratiques comme et. Sur un tel wiki, le code peut être un peu simplifié sous cette forme :



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.

Durant la modification d'une page, une liste de tous les modèles utilisés est disponible sous le formulaire d'édition, dans une section repliable intitulée ' (nommée aussi ', ou  en fonction du contexte). Cette liste fournit un lien pratique vers la page du modèle, ainsi que des informations sur l'état de protection. Les modèles redirigés sont affichés en italiques, avec la cible de la redirection ajoutée comme élément de liste séparé. This list provides a convenient link to the template's page, as well as information about its protection status. Redirected templates are shown in italics, with the redirect target added as a separate list item.



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 Template:Navbar est généré en utilisant le code wiki.

Sur de nombreux wikis, Template:Tl peut être utilisé pour fournir un lien vers un modèle mis en forme de manière à montrer le code entre « double accolades » nécessaire pour transclure le modèle, sans réaliser 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 en utilisant, mais l'approche utilisant le modèle   est plus simple à saisir au clavier. Sur n'importe quel wiki, le modèle Tl s'il est défini, peut ou pas, effectuer le rendu du texte encadré par les balises « code », ou avec un type à largeur fixe. Si ce n’est pas le cas (comme sur ce wiki), 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 » de notre documentation du modèle Tl.



Copier d'un wiki vers un 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) * Sélectionnez la case « ».
 * 4) * Sélectionnez 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.
 * 1) On the new wiki, go to the page with the same name as the template you copied. Hit create/edit and paste the wikitext you copied. In the edit summary of each template, link to the original page for attribution.
 * 1) Back in the original wiki at the edit window, below the edit box, look at the list of "Templates used on this page". For each template listed follow these instructions. Also do that for any template used by any of these templates, and so on.

Cette procédure va copier entièrement le code nécessaire, et sera suffisante pour certains modèles. Notez-bien que ne sont exportés que les éléments de page analysés pour le rendu de la page, donc les sous-pages de documentation ne sont pas exportées car elles ne font pas partie du processus. 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 et recopiez aussi le code dans les modules.

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


Utilisation générale des modèles

 * w:Help:Template – un peu plus détaillé qu'ici
 * 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.

<span id="Special_constructs_used_in_templates">

Constructions spéciales utilisées dans les 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

<span id="Other_relevant_information">

Autres informations relatives

 * – exemple d'utilisation spéciale des modèles.
 * – Utiliser les modèles comme texte initial d'une page
 * – inclure des pages depuis des espaces de noms autres que
 * – Utiliser les modèles comme texte initial d'une page
 * – inclure des pages depuis des espaces de noms autres que
 * – inclure des pages depuis des espaces de noms autres que

<span id="External_links">

Liens externes

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