Aide : modèle

De Wikivoyage
Aller à : navigation, rechercher

Un modèle est un code délimité par {{ et }} lié à l'« expédition Modèles ».

Il sert à reproduire sur plusieurs pages le même message, ou la même mise en page, parfois en fonction de paramètres.

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.

Comprendre ce qu'est un modèle[modifier]

Prenons comme exemple le modèle « {{Wi-Fi}} » qui est inséré dans une page en utilisant la syntaxe {{Wi-Fi|paramètre}} (cette syntaxe est expliquée dans la documentation du modèle, visible dans Modèle:Wi-Fi). Si, par exemple, vous voulez indiquer que dans tel endroit existe une connexion Wi-Fi gratuite, il suffit d'insérer {{Wi-Fi|gratuit}} à l'endroit voulu pour obtenir le rendu « Wi-Fi gratuit. »

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 (trouvée dans la base de données sous licence libre Wikimédia Commons), un séparateur, un texte explicatif et, en médaillon, le texte « Wi-Fi » qui s'affiche au passage de la souris sur l’icône avec l'assurance de respecter la conformité de l'aspect visuel dans tous les articles.

Trouver un modèle[modifier]

Utiliser un modèle[modifier]

Pour insérer un modèle, il faut effectuer un appel en insérant son nom dans des doubles accolades ouvrantes et fermantes en suivant la syntaxe : {{Nom du modèle}}. Par exemple, en saisissant {{Bonjour}}, le contenu du Modèle:Bonjour s'affiche sur la page : « Bonjour ».

Les appels d'un modèle, comme tous ceux de n'importe quelle page de Wikivoyage, 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}}.

Quels modèles pour quelles pages ?[modifier]

  • Pages du guide : le modèle le plus courant est le Modèle:Listing (ou son substitut l'éditeur de listing) ainsi que ses dérivés. Ces modèles peuvent, par ailleurs, contenir une multitude d'autres modèles comme, par exemples, le Modèle:Wi-Fi qui sert à indiquer le type de connexion Wi-Fi disponible dans le lieu décrit par le modèle « Listing » ou encore le Modèle:UNESCO qui permet d'indiquer qu'un lieu est repris dans la liste du patrimoine classé par l'UNESCO, etc. Un autre modèle est le Modèle:Bannière page qui est en quelque sorte la « marque de fabrique » de tous les Wikivoyages.
Sont à proscrire les modèles réservés aux pages de discussion et aux pages personnelles des utilisateurs.

Types de modèles particuliers[modifier]

  • Les infobox qui sont des tableaux qui se placent en haut à droite d’un article comme par exemple le modèle {{Info Ville}}.
  • Les modèles {{Dans}} et {{Thème}} qui créent un lien vers l'entièreté de la hiérarchie supérieure d'un article.
  • Les bandeaux d'avertissement à placer en début de page ou de section de page.
  • Le modèle {{Sommaire alphabétique}} qui, placé au début d'une section, génère des liens vers des sous-sections alphabétiques allant de « A » à « Z ».
  • Les mots magiques qui sont des chaînes textuelles comme __NOTOC__, {{PAGENAME}}, {{formatnum:}}, etc. reconnues par tous les projets de la Wikimedia Foundation.

Créer un modèle[modifier]

Soi-même[modifier]

Stock-dialog-warning.svg Tout d'abord, vérifiez dans la catégorie « Espace Modèle » si un modèle similaire n'existe pas déjà. Il est inutile de « réinventer la roue ».
Ensuite, estimez si le modèle sera utile et donc utilisé. En cas de doute, posez la question au Café des Voyageurs.

La création d'un modèle demande de la prudence. Vous trouverez sur cette page la syntaxe en wikicode à utiliser pendant votre travail tout en sachant que l'inclusion d'un modèle déjà existant fonctionne car les redirections entre modèles fonctionnent.

Il est préférable d'élaborer votre travail dans le bac à sable ou, mieux, au sein d'une de vos pages personnelles qui pourrait, par exemple, être intitulée Utilisateur:Votre nom d'utilisateur/Bac à sable/Test modèle. Cette deuxième solution a l'avantage d'éviter, en principe, toute interférence extérieure.

Balisage de début et de fin : lorsque vous avez terminé, vous insérez votre travail entre les balises <includeonly> et </includeonly> si vous voulez qu'il n'apparaisse pas en mode lecture. Cela peut être intéressant pour des modèles compliqués mais pas obligatoire.

Cette syntaxe, avec les balises de début et de fin comprises ou non, doit immédiatement être suivie de la syntaxe <noinclude>{{Documentation}}</noinclude> qui renverra automatiquement vers la future page de documentation de votre modèle.

Lorsque vous êtes certain de votre « coup », créez une nouvelle page dont le nom doit obligatoirement débuter par « Modèle: » suivit du nom que vous voulez donner au modèle comme ceci : Modèle:Nom du modèle et faites y un copier-coller de votre travail.

Après avoir enregistrer votre modèle, vous pourrez alors passer à la documentation du modèle, qui le rendra compréhensible par tout un chacun. Deux possibilités de documenter un modèle :

En faire la demande[modifier]

La demande de création d'un modèle peut être faite au Café des Voyageurs. Si l'utilisation du modèle demandé semble pertinente, il y a beaucoup de chance qu'un « client » du café s'en chargera.

Modifier un modèle[modifier]

Dans un cas standard, l'accès au code s'obtient via l'onglet de couleur bleue Modifier le wikicode, en haut et à gauche de la page du modèle.

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>).

Attention qu'un modèle est généralement utilisé dans de nombreuses pages, parfois plus d'un millier. Il est donc grandement recommandé de faire une proposition de modification du modèle lui-même au Café des Voyageurs et, si la proposition est acceptée par la communauté, d'adapter au besoin la page de documentation du modèle.

Catégorisation[modifier]

Tous les modèles standards sont classés dans les sous-catégories de la catégorie « Espace Modèle ». Les modèles écrit en language Lua sont classés dans les sous-catégories de la catégorie « Documentation de module ».

Limites[modifier]

Attention ! Le nombre de bytes octroyés, dans un article, aux modèles est limité à 2 097 152 B. En cas de dépassement, il faut envisager de simplifier et limiter le nombre d'appels aux modèles, ou de scinder l'article.

Pour connaître le nombre de modèles contenus dans un article ainsi que leur taille en bytes, deux directions s'offrent à vous :

1. dans la barre de menu de votre navigateur web, allez à :
  • Internet Explorer : onglet Affichage puis, cliquez sur Source.
  • Firefox : onglet Outils, onglet Développement web puis cliquez sur Code source de la page.
  • Google Chrome : faites un clic droit n'importe où sur la page, dans le menu contextuel, cliquez sur Afficher le code source de la page
Dans l'onglet Édition (Internet Explorer et Firefox) ou sur à droite de la barre d'outils (Google Chrome) de la nouvelle fenêtre en langage HTML, cliquez sur Rechercher et inscrivez NewPP limit report
Le système vous renseigne :
  • à « Post-expand include side: » le nombre de bytes, sur 2 097 152 utilisés par les modèles,
  • sous « Transclusion expansion time report » le nombre de modèles inclus dans l'article.

Exemple : l'article Pentagone dans sa version du 25 février 2015 à 16:29

2. dans l'article ouvert en mode lecture :
  • cliquez sur l'onglet Modifier
  • en bas de la page de modification, cliquez sur le bouton Prévisualiser
  • en bas de la page de prévisualisation, activez ► Données d’optimisation de l’analyseur :

Exemple : l'article Pentagone dans sa version du 21 avril 2015 à 16:31

Statistiques[modifier]

Il est possible de connaître le nombre de pages dans lesquelles un modèle est inclus. Pour cela, allez sur la page du modèle. Sous la rubrique Outils (dans la colonne de gauche), cliquez sur Pages liées pour obtenir toutes les pages qui pointent vers ce modèle.
Pour prendre connaissance uniquement des pages d'inclusion, dans le cadre « Filtres », cliquez sur les interrupteurs Masquer les liens et Masquer les redirections.

Voir aussi[modifier]