Help:Templates/fr

Si vous avez des textes ou présentations standards que vous voulez inclure dans plusieurs pages, les modèles de MediaWiki remplissent cette fonction (par exemple le bandeau d'avertissement ci-dessus qui se trouve sur toutes les pages d'aide). À la différence des extensions et des fichiers média, il n'y a pas de lieu central de 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 Wikipedia) 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 " " (ou  dans les anciennes versions), qui l'assigne à cet espace de noms ; 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 « Modèle: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, quand cette page est visualisée le texte "Bonjour ! Bienvenue sur le wiki." apparaitra à la place de. 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.

Ceci est le mécanisme de base. Il y a plusieurs fonctionnalités supplémentaires de transclusion qui enrichissent ce mécanisme et rend 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 "Modèle: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 écriture, le lien est remplacé une fois pour toutes par le contenu de la page Modèle:Nom du modèle au moment où vous enregistrez votre page. C'est une substitution définitive qui est opérée. Le contenu du modèle devient alors un élément à part entière de votre page, et peut être modifié ensuite normalement, indépendamment de l'original. Les changements ultérieurs du modèle ne se propageront pas à votre page.
 * — ceci a été introduit pour tenir compte des substitutions qui ne rompent pas la transclusion. Voir w:en:Help:Substitution.
 * inclut le modèle dans la syntaxe brute wiki, comme le ferait un.

Dans les faits, 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 aura un motif (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 où qu'elle soit utilisée, vous pouvez définir un modèle appelé Modèle:Merci, par exemple. Si la note devrait avoir la même apparence chaque fois qu'un utilisateur remercie un autre utilisateur, son contenu spécifique (c.à.d la raison et la signature) sera différent. Pour cette raison, vous devriez les passer en tant que paramètres. Si on omet les autres éléments de mise en forme de la boite et de l'image, le contenu principal du modèle sera celui-ci :

Un petit remerciement... pour. bises,

Notez l'utilisation de  et. C'est la manière d'identifier, à l'intérieur du modèle, les paramètres qui lui seront passés lorsqu'il sera utilisé. Notez qu'à l'intérieur du modèle chaque paramètre est encadré par trois accolades :. C'est différent 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 , 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 :

Remarque : identifier les paramètres selon l'ordre (avec, etc.) marche seulement avec des paramètres anonymes. Si votre page identifie n'importe quel paramètre par un numéro ou un nom, comme vu ci-dessous, cette méthode ne sera plus disponible pour le modèle qui les reçoit.

Remarque : le signe égal à l'intérieur d'un paramètre de modèle sans nom est interprété comme un paramètre nommé ; le texte qui précède le signe égal est considéré comme le nom du paramètre, et le texte qui le suite comme sa valeur. Un problème courant survient lorsque vous voulez inclure un lien externe ou un élément HTML avec des attributs (voir tâche 16235) Pour le contourner, employez plutôt des paramètre nommés, voire des paramètres numérotés comme expliqué dans la section suivante.

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

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

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

Un petit remerciement... pour. bises,

Dans le modèle, on utilise  et   pour identifier chaque paramètre, au lieu de 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 :

L'avantage d'utiliser des paramètres nommés dans votre modèle, en plus d'être flexible dans l'ordre de passage des 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 transcluez un modèle qui attend des paramètres, mais sans les lui fournir, de cette manière :

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

À partir du moment où aucun paramètre 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 :

Un petit remerciement... pour. bises,

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

Contrôler l'inclusion des modèles
Vous pouvez contrôler l'inclusion par l'utilisation des balises  et.

Tout ce qui est contenu entre  et   est affiché uniquement sur la page du modèle et ne sera pas inclus. Les applications possibles sont :


 * la catégorisation des modèles
 * des interwikis pour les modèles similaires dans d'autres langues
 * l'explication de l'utilisation du modèle (nom des paramètres...)

Le contraire est. Tout ce qui est contenu entre  et   sera affiché uniquement quand le modèle est inclus. Une application évidente est d'ajouter toutes les pages contenant un certain modèle dans une catégorie, sans vouloir mettre le modèle dans cette catégorie.

Notez qu'il y a des problèmes de mise à jour : si vous changez les catégories dans un modèle, les catégories dans les pages contenant celui-ci ne seront pas mises à jour tant que la page n'est pas éditée.
 * 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, pour éviter l'affichage d'un résultat non désiré lorsque le modèle attend des paramètres.

Tout ce qui est en dehors des balises  et   est affiché normalement, que ce soit sur la page du modèle même, ou sur une page où il est inclus.

Organiser les modèles
Pour que les modèles soient effectifs, les utilisateurs doivent les trouver et trouver 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 :

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

Copier d'un wiki à un autre
Les modèles requièrent parfois du CSS ou d'autres modèles, les utilisateurs ont donc des problèmes lorsqu'ils copient des modèles d'un wiki à l'autre. La marche à suivre suivante devrait marcher pour la plupart des modèles :

Code MediaWiki
Si vous avez les droits d'import sur le nouveau wiki :
 * 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 ex. "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) * Click "".
 * 6) Allez à Spécial:Importer sur le nouveau wiki et téléversez le fichier XML.

Si vous n'avez pas les droits d'import sur le nouveau wiki :


 * 1) Go to the template you want to copy from the original wiki. Go to the edit page, and copy all the wikitext
 * 2) 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.
 * 3) 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.

This will copy the entire code necessary, and will suffice for some templates. If it doesn't work also check for red links listed under "Pages transcluded onto the current version of this page:", below the edit box. If there are any repeat the above steps for these as well.

After sucessfully importing the template and all its linked templates from the other wiki, edit it to change customisations to suit your wiki. For example to change a logo, remove redundant categories or red links.

Extensions
ParserFunctions est une extension souvent utilisée dans les modèles. Visitez la page et vérifiez si certaines des fonctions listées sont utilisées dans les modèles que vous avez copié. Si c'est le cas, vous devrez installer. Pour cela vous aurez besoin des droits d'administrateur système pour accéder au serveur de votre installation MediaWiki.

Une autre dépendance utilisée dans les modèles, notamment ceux de Wikipédia, est Lua. La présence de balises  dans le code des modèles est un bon marqueur. S'il est utilisé, vous devrez installer l'extension et les droits d'administrateur système seront aussi nécessaires. Voir la page de l'extension pour plus d'instructions sur son installation et son utilisation.

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 en être la cause. Pour copier le CSS et Javascript requis sur votre wiki, vous devriez avoir besoin des droits d'administrateur, car vous devrez éditer les messages du système dans l'espace de nom "MediaWiki:".


 * 1) Look for the use of CSS classes (text like  ) in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
 * 2) Si le modèle copié ne marche 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. Normallement, 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 servir d'indice pour identifier la fonction de chaque partie.

Voir aussi

 * – a template special use case example
 * – fancy stuff you may find in some templates
 * m:Help:Template – contains a much more thorough manual on how exactly templates function
 * m:Help:Advanced templates – describes even more advanced techniques such as dynamic template calls and variable variables
 * m:Help:Embed page – embedding pages from namespaces other than.
 * Importing Wikipedia infoboxes tutorial
 * m:Help:Embed page – embedding pages from namespaces other than.
 * Importing Wikipedia infoboxes tutorial