Aide:Modèle

(Redirigé depuis Aide:Template)
Wikicode
Cette page ne concerne que le wikicode (liens « modifier le code »).
Voir la page d'aide pour l'éditeur visuel.
Quelle différence ?
Niveau avancé
Un modèle sert à reproduire sur plusieurs pages le même message, ou la même mise en page, parfois en fonction de paramètres.

Il s'agit d'un élément pré-écrit, plus ou moins complexe, destiné à être incrusté dans une page afin d'obtenir instantanément le résultat visuel souhaité (formatage, affichage d'éléments spécifiques, etc.). Les bandeaux en haut des articles, les infobox, l'affichage des siècles... sont des modèles.

En wikicode, un modèle est délimité par des doubles accolades, « {{ » et « }} » ; l'éditeur visuel le caractérise par une pièce de puzzle icône de gestion d'un modèle dans l’éditeur visuel.

Un modèle est lié à une page de l'espace de noms « Modèle ». Il est souvent symbolisé dans les discussions par son nom entouré de {{ et }}.

Les modèles sont accessibles en édition par tous les contributeurs, c'est pourquoi il est nécessaire de les documenter. Il faut aussi les retoucher avec prudence, car une modification apparaît sur de nombreuses pages (parfois plusieurs milliers) et provoque sur les serveurs des mises à jour de cache en cascade[1].
Voir aussi : Aide:Module
Important : Cette page présente une aide générale sur les modèles. Pour une liste de modèles en fonction de leur rôle, voir Aide:Liste de modèles.

Comprendre ce qu'est un modèle par l'exemple

modifier

Prenons comme exemple le modèle « {{Article détaillé}} » qui est inséré dans une page en utilisant la syntaxe {{article détaillé|article 1|article 2}}. On l'utilise pour indiquer par exemple dans l'article Loup dans la culture qu'il existe un article détaillé sur le Loup dans la culture européenne, on insère le code {{article détaillé|Loup dans la culture européenne}} à l'emplacement où le bandeau doit apparaître :

Le rendu sur la page :

Cette présentation est ainsi obtenue en quelques secondes, sans avoir à saisir à chaque fois les lignes de code qui insèrent successivement l'icône d'une loupe (trouvée dans la base de données Commons), des séparateurs, un texte, un lien interne, des variantes typographiques, etc., le tout avec l'assurance de respecter l'aspect visuel requis dans tous les articles pour ce type d'avertissement, voté par la communauté.

Ce contenu n'est pas enregistré dans le texte de l'article, mais dans la page Modèle:Article détaillé. Celle-ci est utilisée par l'article, il charge le contenu de la page Modèle: pour l'afficher. Chaque texte entre {{ }} correspond donc à une page existante commençant par Modèle:.

Comment trouver rapidement un modèle existant ?

modifier

Pour retrouver rapidement un modèle existant, écrivez « Modèle:<nom du modèle> » (sans les balises {{ }}) dans le champ de recherche.

La liste des modèles utilisés dans une page est présente :

  • en sélectionnant « modifier le code » : sous le titre Modèles utilisés par cette page en bas de page, en dessous des boutons « Publier les modifications », « Prévisualiser », etc. ;
  • en sélectionnant « Information sur la page » : sous le titre Propriétés de la page.

Les modèles sont groupés dans un espace de noms « Modèle: ». En voici une liste alphabétique.

On peut aussi le rechercher dans la Catégorie:Espace Modèle.

Comment utiliser un modèle ?

modifier

Pour insérer un modèle, il faut effectuer un appel par des doubles accolades en suivant la syntaxe : {{Nom du modèle}}. Par exemple, en saisissant {{Merci}}, le contenu du Modèle:Merci est affiché sur une page : « Merci   ». Les modifications de Modèle:Merci s’appliquent sur les diverses pages où est inséré le modèle.

Les modèles, comme tous les articles de Wikipédia, sont indifférents à la casse uniquement pour leur lettre initiale : {{Nom du modèle}} est équivalent à {{nom du modèle}} mais pas à {{NOM DU MODÈLE}}.

Paramètres

modifier

Certains modèles (par exemple {{Article détaillé}}) ont besoin de paramètres pour adapter leur comportement. Ces paramètres, obligatoires ou facultatifs, sont séparés par des barres verticales (|). Ces paramètres peuvent être soit :

  • positionnels, qui sont renseignés les uns à la suite des autres : {{Nom du modèle | Paramètre 1 | Paramètre 2…}};
  • nommés, identifiés par leur nom : exemple avec {{boîte déroulante}} : {{boîte déroulante| titre = titre voulu | couleur = couleur choisie }}, les paramètres sont titre et couleur.

Pour plus de détails sur les paramètres, se reporter au chapitre Modèles à paramètres.

Substitution

modifier

La substitution permet de remplacer l’appel au modèle {{Nom du modèle}} par le code du modèle (c’est-à-dire le patron du modèle). Elle s’effectue par la syntaxe {{subst:Nom du modèle}}. Il n’est généralement pas nécessaire de substituer un modèle car, si le modèle d’origine est modifié, les substitutions ne le sont pas. La substitution n’a pas vocation à être utilisée dans les articles. À noter qu’il n’existe aucune norme sur l’usage du subst: et que son utilisation doit donc être réfléchie.

Un modèle contenant un lien temporaire ou susceptible de changer devrait être ajouté par {{subst:Nom du modèle}}. Un exemple d’utilisation de la substitution est lors de l’ajout de {{Bienvenue nouveau}} sur la page de discussion d’un nouvel utilisateur ; ce dernier pourra alors, en modifiant sa page, prendre pleinement conscience de la syntaxe utilisée sur le site.

La substitution ne fonctionne pas entre les balises <ref></ref> utilisées pour les références, il s'agit d'un bug connu, voir T4700 et gerrit:272916.

Deux types particuliers : les palettes et les infobox

modifier

Les palettes de navigation sont des tableaux déroulants qui se placent en bas d’un article.

Les infobox sont des tableaux qui se placent en haut à droite d’un article. Il en existe plusieurs générations, les dernières versions (V2 et V3) étant construites sur un modèle modulaire.

Les taxobox sont une variante des infobox modulaires de type V3.

Modèles spéciaux

modifier

Certains modèles permettent d’avoir la date, l’heure, etc.

Insérer un lien vers un modèle

modifier

Pour donner un lien vers un modèle, on peut utiliser {{m}}.

Comment créer un modèle ?

modifier

Comment modifier un modèle ?

modifier

Dans un cas standard, l'accès au code s'obtient via l'onglet « Modifier le code » à partir de la page Modèle:Nom du modèle. Les cas où le modèle est codé en Lua sont traités dans la page module. Il est conseillé de recopier le contenu du modèle dans la sous-page /Bac à sable du modèle (Modèle:Nom du modèle/Bac à sable), d'y effectuer sa modification et de la tester dans la sous-page de test (Modèle:Nom du modèle/Test).

Un lien à ces deux pages se trouve en bas du modèle de documentation.

Comment documenter un modèle ?

modifier

Remarques et astuces

modifier

Sur la page du modèle, avant modification, on peut cliquer sur l’hyperlien « Pages liées » du menu de gauche pour consulter les pages utilisant le modèle et vérifier qu’elles ne seront pas perturbées.

Les noms de modèles utilisant des mots abrégés ou collés sont difficiles à retenir car aucune convention ne s’est imposée. Il n’y a pas de raison technique pour ne pas s’inspirer des conventions sur les titres aussi dans les noms de modèle.

Lien interlangue

modifier
Ce paragraphe d'aide décrit les liens interlangues situés dans le texte des pages de Wikipédia, utilisés pour les catégories et les modèles notamment. Depuis le 6 mars 2013, les articles utilisent Wikidata pour générer les liens interlangues. Vous pouvez consulter la page donnant les instructions pour modifier les liens interlangues via Wikidata.


Si le modèle contient un lien interlangue, alors ce lien est inclus dans toutes les pages utilisant le modèle, ce qui n’est généralement pas le résultat voulu. Si deux liens interlangue vers une même autre langue se trouvent dans une page, le résultat est imprévisible. On évitera ces conflits en utilisant les balises d’exclusion sélective et d’inclusion sélective.

Catégorisation

modifier

Si le modèle appartient à une catégorie (c’est-à-dire que la page du modèle contient un libellé de la forme [[Catégorie:Nom d'une catégorie]]) et si l’on ne fait pas simultanément usage de la balise d’inclusion sélective <noinclude>, tous les articles contenant le modèle appartiendront à cette catégorie. On peut utiliser cette astuce, par exemple, pour obtenir la liste de tous les articles ébauche d’un domaine donné. Il faut toutefois une mise à jour du cache de chaque page.

Tous les modèles sont classés dans les sous-catégories de la Catégorie:Espace Modèle.

Conventions à appliquer aux catégories dédiées aux modèles :

  1. Boîte Utilisateur : [[Catégorie:Boîte utilisateur thème]] ;
  2. Infobox : [[Catégorie:Modèle infobox thème]] ;
  3. Palette de navigation : [[Catégorie:Palette Thème]], avec Thème débutant par une majuscule ;
  4. Tout autre modèle : [[Catégorie:Modèle thème]], sauf exceptions (Méta, Sous-page, Documentation, Test, Maintenance, Redirection).

Limites

modifier

Attention : le nombre d'appels à certaines ParserFunctions est plafonné à 500 par article, au-delà on se heurte au message suivant : « Attention : Cette page contient trop d'inclusions de modèles. Certaines inclusions ne seront pas effectuées. » Ou à cet autre : « Attention : cette page contient de trop nombreux appels à des fonctions coûteuses de l'analyseur syntaxique. Il devrait y avoir moins de 500 appels, alors qu'il y en a maintenant xxx. » Il faut alors envisager de simplifier et limiter le nombre d'appels aux modèles, ou de scinder l'article (voir en:Wikipedia:Template limits).

On peut trouver le nombre d'appels de fonctions parseurs dans un article en recherchant « Expensive parser function count: » dans le code HTML généré (voir Catégorie:Page avec trop d'appels dispendieux de fonctions parseurs pour les articles concernés). Depuis 2013 ou 2014, si l'on modifie en wikicode tout l'article, avec une prévisualisation, en bas de la page apparait une section « Données d’optimisation de l’analyseur » présentant un tableau avec la ligne « Nombre de fonctions d’analyse coûteuses ».

Remarque : Les fonctions considérées comme dispendieuses sont, en août 2012 : {{#ifexist:...}} {{PAGESINCATEGORY:...}} {{PAGESINCAT:...}} {{PAGESIZE:...}}

Statistiques

modifier
  • (fr) Templatecount permet de connaître le nombre de pages dans lesquelles le modèle est inclus.
  • (fr) wstat.fr permet de prendre connaissance d'un certain nombre de statistiques concernant un modèle : le nombre de paramètres, le nombre de pages où ce modèle est inclus directement, les paramètres utilisés, la liste des articles qui utilisent des paramètres en double ou inexistants.
    Attention.
    • Ce site ne présente que les pages où le modèle est utilisé directement, c'est-à-dire le nombre de fois où son nom ou celui d'une de ses redirections est utilisé. Si c'est un second modèle qui l'utilise, les inclusions de ce second modèle ne sont pas comptées. Il est ainsi possible de savoir quelle est la charge de travail en cas de modification du modèle.
      Exemple : (à venir)
    • Par défaut, les statistiques ne prennent pas en compte les pages utilisateur et discussion ; cliquez sur le lien «  Avec utilisateur: et discussion*  » pour les prendre en compte.

Sur les autres projets Wikimedia :

Notes et références

modifier
  1. La mise à jour de la mémoire cache en cascade sur les serveurs est aussi appelée « job queue ».

Voir aussi

modifier

Articles connexes

modifier