Projet:Modèle/Harmonisation

Modèle       

Données clés

Aide et syntaxe • FAQ

Liste • Modèles spéciaux

Aide:Modèles courants

ParserFunction • Mots magiques

Espace Modèle

Projets

Demander un modèle

Modèle • Apparence

Projet d’harmonisation

Palette de navigation

Qu'est-ce qu'une palette de navigation ?

{{Méta palette de navigation}}

Palette de navigation

Projet palette

Infobox

Qu'est-ce qu'une infobox ?

Demander une infobox

Apparence

Modèle infobox

Projet infobox

Bandeau

Qu'est-ce qu'un bandeau ?

Liste des bandeaux de maintenance

Liste des bandeaux d'avertissements permanents

Projets connexes

Wikidata

Cette page a pour but de définir des normes (une charte) pour les modèles en vue d'une campagne d'harmonisation des modèles (des infoboxes plus particulièrement). Il ne s'agit pas ici de juger des apparences des modèles (cela concerne plutôt la charte graphique et la gestion des styles CSS), mais d'harmonisation des titres, du paramétrage, des techniques de codage, du jargon, des méta-modèles, des infoboxes, des palettes...

Actuellement, l'on procède par petites retouches (ce qui multiplie les interventions de bots), sans coordination, et pas toujours dans le bon sens. Ce travail devrait aboutir à la création d'un standard (une sorte de label de qualité et de conformité) ce qui permettra une harmonisation plus efficace.

Titre

Les noms (titres) de modèles obéissent aux conventions générales sur les titres. Il existe de plus une convention de titre de l'infobox particulière. À ce titre, les palettes de navigation en bas des pages obéiront à la même convention des titres que les Infoboxes ; par exemple {{Palette Nom de la palette}}

Évitons de reformuler toutes ces conventions. On se borne ici à mettre le doigt sur certains « mauvais plis » et à rectifier certains points :

Titre des catégories

On ne supprimera pas les mots de liaison dans les titres de catégorie.

Le titre d'une sous-catégorie de Catégorie:Espace Modèle doit commencer par le mot "Modèle".

Note : Ces conventions induisent de nombreux "renommages". Par exemple :

• Catégorie:Modèle lien devient Catégorie:Modèle de lien
• Catégorie:Modèle bandeau devient Catégorie:Modèle de bandeau

Sous-pages

Le (sous-)titre d'une sous-page doit commencer par une majuscule. On mettra donc toujours une majuscule après le "/".

Note : Cela contredit « On ne mettra pas de majuscule après le / » qui n'était pas du tout conforme à l'usage général.

Usage des mots de liaison

Toute ablation d'un mot de liaison dans le titre d'un modèle doit être marquée par une majuscule. Par exemple, "Infobox de ville" ou "Infobox Ville" ; mais pas "Infobox ville".

Lorsqu'un modèle appartient à un jeu (un modèle d'infobox, par exemple), il est fortement recommandé, pour des raisons fonctionnelles, d'omettre les mots de liaison.

Note : Cela contredit « On ne supprimera pas les mots de liaison : {{Infobox Province du Maroc}} et non {{Infobox Province Maroc}} ». Noter l'incohérence ; puisque le titre correct doit donc logiquement être {{Infobox de province du Maroc}}.

Modèles génériques

L'usage du préfixe "Méta minuscule..." est recommandé pour les modèles génériques.

Modèles de balises "Début" "Fin"

à débattre

Exemples

• {{Début de carte}} • {{Carte:début}} • {{Image label début}}
• {{Boîte déroulante/début}}
• {{Arbre généalogique/début}}

Jargon

Fixer le jargon est un effort du Projet:Aide, qui se concrétise par la création de patchs info pour le jargon technique. Concernant les modèles, il est nécessaire de définir un jargon :

• pour les types de modèle
• pour les paramètres de modèle

Mieux définir les types de modèle, permettra tout d'abord, une meilleure catégorisation. De plus, à terme, on devrait aboutir à : « de tel type = basé sur tel méta-modèle ».

Types de modèles à mieux définir : infobox • palette (de navigation) • (modèle de) lien, ...

Palette de navigation

Une palette de navigation est un large cadre horizontal contenant un ensemble important de liens relatifs à un thème donné. Elle se place en bas de page.

Notes :

• Actuellement les menus (appelés palettes verticales) sont assimilés à des palettes. Donc cette définition n'est pas consensuelle.
• Le terme palette est associé à palette de navigation ou palette de couleurs. Cependant le terme palette de couleurs peut être remplacé par le terme Nuancier. Ainsi on utilisera exclusivement la typographie {{Palette thème}} pour les palettes de navigation.

Menu

Un menu est un encadré, flottant à droite, contenant un ensemble de liens (agencés verticalement) relatifs à un thème donné. Il se place en tête des pages recensées dans le menu (entre autres).

Note : Les menus sont plus particulièrement adaptés aux pages non-encyclopédiques.

Infobox

Une infobox sur Wikipedia est une fiche d'informations formatées qui est présente dans des articles de sujet similaire. Un modèle d'infobox est un encadré flottant à droite, qui se place en tête d'article.

Paramétrage

Les noms (titres) de modèles obéissent aux conventions générales sur les titres.

Le manque d'harmonisation du paramétrage des modèles est sûrement le plus gros problème actuel ; le retard est considérable. Il existe déjà une petite convention des paramètres de l'infobox. Cela reste trop superficiel.

Une conception plus sérieuse des modèles passe par un typage des paramètres. Créer un jargon pour le paramétrage est une manière de définir des types standards.

Lors du choix des informations à afficher via les paramètres à renseigner, généralement lors de discussions, il est utile de faire une synthèse. Autrement dit, il ne faut pas que l'Infobox se substitue à l'article. Une Infobox est une présentation sommaire d'un sujet donné, affichant des informations communes avec des variations sur le même thème. Inutile de trop spécialiser l'infobox ou de trop l'informer.

Nom des paramètres

Rappel des règles plus ou moins consensuelles

Il faut, de manière générale, que le nom d'un paramètre reste au plus proche du français et soit autant que possible immédiatement compréhensible. Donc :

• pas de typographies bizarres
• pas de majuscules (donc ni « Titre », ni « TITRE »)
• pas d' "accolement" (donc pas de CamelCase)
• pas d'abréviations, sauf, à la rigueur, les plus courantes (pas de points aux abréviations)
• mettre les accents (mais éviter les mots accentués lorsque c'est possible)
• uniformiser l'emplacement des tubes « | » et des signes égal « = ».

À faire	À éviter
{{Infobox Nom de l'infobox | nom = | image = | légende = | autre = }}	{{Infobox Nom de l'infobox| nom =| image =| légende =| autre =| }}	{{Infobox Nom de l'infobox |nom= |img= |lég= |aut= }}

Notes :

• {{Ouvrage}} utilise isbn, issn plutôt que ISBN, ISSN
• {{Lien web}} utilise url plutôt que URL

Usage du "_"

Ne pas employer de "_" (underscore) entre les mots dans les noms de paramètres. Donc "nom local" et non "nom_local".

Motivation :

• la possibilité de la présence d'espace dans les paramètres vaut pour une recommandation implicite (à quoi ça sert que les MediaWikipédiens se décarcassent ?) ;
• le contributeur moyen n'est pas initié à ces "façons" de programmeur.
• le projet Wikidata n’emploie pas l'underscore (emploi de l'espace)

Usage de l'anglais

Tout paramètre de modèles employés dans les articles doit être en français. En revanche, l'usage de l'anglais est permis (voire recommandé) pour les modèles à "usage interne" ; en particulier, lorsque ce paramètre fait référence aux mots-clés du langage HTML+CSS : class, float (puisque les valeurs sont en anglais), ...

Motivation :

• l'usage de l'anglais est plus clair, plus explicite, dès que l'on rentre dans des considérations plus techniques ;
• l'usage de anglais facilite le portage interwiki.

Valeur des paramètres

Recommandations générales pour la valeur des paramètres

Formatage des valeurs

Pour la valeur des paramètres, il faut employer, autant que possible, des valeurs brutes (c'est-à-dire, sans lien ni formatage).

(bien sur, cette recommandation s'adresse aux développeurs de nouveaux modèles, non aux utilisateurs qui doivent suivre la documentation du modèle en place.)

• Motivation
  • les progrès des modèles permettent d'assurer un formatage automatique, et la déduction automatique de certaines valeurs (par exemple : densité=population/superficie pour les villes)
  • intégration des métadonnées (voir Wikipédia:Métadonnées personne)
  • Permet une meilleur exploitation du modèle : utiliser "Iran" plutôt que "Iran" permet la géolocalisation et l'usage de {{Iran}} : Iran
  • Cela évite de mettre n'importe quoi.

Paramètres non valorisés

Il faut éviter de mettre le caractère point d'interrogation (?) ou étoile (*), si la valeur du paramètre ne peut être déterminée et renseignée :

• Ce qu'il faut faire                :    | superficie =
• Ce qu'il ne faut pas faire   :    | superficie = * ou | superficie = ?

Il faut éviter de mettre des commentaires (<!-- commentaire -->) si le paramètre ne contient aucune valeur.^{[pourquoi ?]}

• Ce qu'il faut faire                :    | superficie =
• Ce qu'il ne faut pas faire   :    | superficie = <!-- commentaire -->

Jargon pour le paramétrage

On recommande ici la standardisation de certains paramètres généraux par l'emploi du "jargon". Définir un jargon pour les paramètres clarifiera leur usage et facilitera la documentation des modèles.

Paramètres à mieux définir : couleur • lien • texte • contenu • population • style ...

nom

Le paramètre nom est un paramètre facultatif qui devrait être commun à toutes les infobox. Il ne sert qu'à résoudre des problèmes d'homonymies : Ainsi on écrira nom=Géorgie dans les infobox des articles Géorgie (pays) et Géorgie (États-Unis). De même, on écrira nom=Corse dans les infobox des articles Corse (langue) et Corse (département), mais c'est inutile dans celle de Corse.

Dans le code de l'infobox, on devrait trouver {{{nom|{{PAGENAME}}}}}, mais malheureusement, il est plus prudent (donc fortement recommandé) d'écrire {{#if:{{{nom|}}}|{{{nom}}}|{{PAGENAME}}}}

Le paramètres nom se place conventionnellement en tête des paramètres.

Convention

Le paramètre nom détermine le titre de l'infobox et n'est à employer qu'exceptionnellement lorsque le nom de la page ne convient pas (en savoir plus).

Notes

• Malheureusement, on trouve d'autre "nom" pour nom, par exemple nom français).
• Conventionnellement, on emploie plutôt titre pour ... le titre ;) dans les modèles de cadres : encadrés, palettes de navigation, menus, ...

latitude et longitude

Les paramètres latitude et longitude sont un parfait exemple pour illustrer l'absence actuelle d'harmonisation ... et introduire l'usage du patch info pour le jargon du paramétrage.

• beaucoup d'infobox ont des paramètres formatés en sexagésimal
• certaines utilisent le modèle {{Coord}}
• etc. (il suffirait de fouiller un peu)

Dans tout ces cas, les coordonnées sont inutilisables (en l'état) pour la géolocalisation et geohack ... et la conversion décimale est difficilement faisable par un bot.

Convention

Un paramètre de latitude est une latitude exprimée en degrés entre -90 (au Pôle Sud) et 90. Il existe deux formats : numérique décimale (un « . » pour la virgule) ou la syntaxe DMS : « dégrés/minutes/secondes/N ou S » (en savoir plus).

pays

Convention

La valeur du paramètre pays doit être un simple nom (ni lien, ni modèle, mais la syntaxe pays 1/pays 2 est parfois possible) pris parmi les listes établies (en savoir plus).

Particularité

• Les Catégorie:Modèle pays et drapeau historique peuvent être employées dans certains cas (domaine sportif, par exemple). Il est alors préférable d'employer le terme nation.

Motivation

• Permet une meilleure exploitation du modèle : utiliser "Iran" plutôt que, tantôt "[[Iran]]", tantôt "{{Iran}}" ou autres, permet la géolocalisation et l'usage systématique de {{Iran}} : Iran.

Note

Dans le cas où le pays peut être multiple, on emploiera un autre nom pour le paramètre : nations, nationalités ou autres.

Liste des pays actuels

• Afghanistan
• Afrique du Sud
• Albanie
• Algérie
• Allemagne
• Andorre
• Angola
• Antigua-et-Barbuda
• Arabie saoudite
• Argentine
• Arménie
• Australie
• Autriche
• Azerbaïdjan
• Bahamas
• Bahreïn
• Bangladesh
• Barbade
• Belgique
• Belize
• Bénin
• Bhoutan
• Biélorussie
• Birmanie
• Bolivie
• Bosnie-Herzégovine
• Botswana
• Brésil
• Brunei
• Bulgarie
• Burkina Faso
• Burundi
• Cambodge
• Cameroun
• Canada
• Cap-Vert
• République centrafricaine
• Chili
• Chine
• Chypre
• Colombie
• Comores
• République démocratique du Congo
• République du Congo
• Corée du Nord
• Corée du Sud
• Costa Rica
• Côte d'Ivoire
• Croatie
• Cuba
• Danemark
• Djibouti
• Dominique
• République dominicaine
• Égypte
• Émirats arabes unis
• Équateur
• Érythrée
• Espagne
• Estonie
• États-Unis
• Éthiopie
• Fidji
• Finlande
• France
• Gabon
• Gambie
• Géorgie
• Ghana
• Grèce
• Grenade
• Guatemala
• Guinée
• Guinée-Bissau
• Guinée équatoriale
• Guyana
• Haïti
• Honduras
• Hongrie
• Inde
• Indonésie
• Irak
• Iran
• Irlande
• Islande
• Israël
• Italie
• Jamaïque
• Japon
• Jordanie
• Kazakhstan
• Kenya
• Kirghizistan
• Kiribati
• Koweït
• Laos
• Lesotho
• Lettonie
• Liban
• Libéria
• Libye
• Liechtenstein
• Lituanie
• Luxembourg
• Macédoine
• Madagascar
• Malaisie
• Malawi
• Maldives
• Mali
• Malte
• Maroc
• Îles Marshall
• Maurice
• Mauritanie
• Mexique
• Micronésie
• Moldavie
• Monaco
• Mongolie
• Monténégro
• Mozambique
• Namibie
• Nauru
• Népal
• Nicaragua
• Niger
• Nigeria
• Norvège
• Nouvelle-Zélande
• Oman
• Ouganda
• Ouzbékistan
• Pakistan
• Palaos
• Panama
• Papouasie-Nouvelle-Guinée
• Paraguay
• Pays-Bas
• Pérou
• Philippines
• Pologne
• Portugal
• Qatar
• Roumanie
• Royaume-Uni
• Russie
• Rwanda
• Saint-Christophe-et-Niévès
• Sainte-Lucie
• Saint-Marin
• Saint-Vincent-et-les-Grenadines
• Salomon
• Salvador
• Samoa
• Sao Tomé-et-Principe
• Sénégal
• Serbie
• Seychelles
• Sierra Leone
• Singapour
• Slovaquie
• Slovénie
• Somalie
• Soudan
• Sri Lanka
• Suède
• Suisse
• Suriname
• Swaziland
• Syrie
• Tadjikistan
• Tanzanie
• Tchad
• République tchèque
• Thaïlande
• Timor oriental
• Togo
• Tonga
• Trinité-et-Tobago
• Tunisie
• Turkménistan
• Turquie
• Tuvalu
• Ukraine
• Uruguay
• Vanuatu
• Vatican
• Venezuela
• Viêt Nam
• Yémen
• Zambie
• Zimbabwe

carte/géolocalisation

Convention

La valeur du paramètre carte dans les infobox doit être un nom de code de la carte pour permettre l'emploi d'une meilleure carte que celle du pays.

Notes

• Cela oblige à rectifier de nombreux modèles : {{Infobox Montagne}} • {{Infobox Grotte}} • ...

• géolocalisation semble s'imposer.
• Le recourt à ce paramètre doit rester très marginal.

Subdivisions administratives

• Il est recommandé d'utiliser « subdivision<numéro> » à la place de « région » et « lien subdivision<numéro> » à la place de « lien région » dans les modèles non spécifiques à la France.

couleur

On trouve, de même, divers usages qui se traduisent par des valeurs différentes et incompatibles :

• red, #123456, #FE2, transparent
• 123456
• rouge, bleu, ... ({{Cadre}})
• 70,130,180

Convention

La valeur d'un paramètre de couleur doit être conforme à la syntaxe HTML pour les couleurs (en savoir plus).

style

Convention

Le paramètre style correspond à l'attribut style du langage HTML et sa valeur est un ensemble de propriétés CSS additionnelles. Ce paramètre est toujours facultatif. Il doit être réservé aux méta modèles ; donc ne pas être utilisé directement dans les articles.

Note

• Un usage typique de ce paramètre est donc :

<div ... style="...;{{{style|}}}"> ... </div>

Motivation

• l'utilisation de ce paramètre dans les articles est en désaccord avec le principe même d'une charte graphique.

image

Convention

Le paramètre image ne doit contenir que le nom du fichier image sous la forme NomFichier.Extension.

Note

• On lui associe les paramètres suivants :
  • taille image, pour une taille d'image en nombre de pixel. Donnée numérique sans le suffixe « px ».
  • ou upright, pour ajuster automatiquement les dimensions des images en fonction des préférences de l'utilisateur.
  • légende : légende à afficher sous l'image.
  • alternative : alternative textuelle à l'image
• Pour des types spécifiques d'images, et en prenant comme exemple les blasons, on utilisera la convention suivante : blason, taille blason, légende blason, alternative blason

Motivation

• Voir Wikipédia:Mise en forme des images.

lien

Un jargon pour le paramètre lien est nécessaire pour préciser la possibilité (et le cas échéant la manière) d'utiliser une ancre ou le modèle {{!}}.

texte

Un jargon pour le paramètre texte est nécessaire principalement pour signaler le problème de syntaxe récurrent : celui de la présence du signe "=" dans la valeur d'un paramètre non nommé. Voir par exemple Discussion Modèle:Référence souhaitée#Problème de syntaxe.

Paramètre booléen

Définition

Un paramètre booléen (parfois appelé indicateur ou drapeau) ne prend que 2 valeurs : faux (0/false/nul/non/off/...) / vrai (1/true/non nul/oui/on/...). En tant que paramètre de modèle, ces valeurs sont : manquant ou vierge (faux) / quelconque (1 ou oui sont recommandées) (vrai).

Exemples

Quelques exemples de paramètres booléens dans les modèles :

• le paramètre âge de {{date}} permet d’afficher le temps écoulé :

Code wiki	Rendu
{{Date|2001-10-14|}}	14 octobre 2001
{{Date|2001-10-14|âge=oui}}	14 octobre 2001

• le paramètre code est employé dans {{Documentation paramétrage de carte}} pour passer à une version optimisée.

Description détaillée

Le bon sens veut qu'un paramètre booléen soit facultatif et prenne la valeur « faux » par défaut^{[réf. nécessaire]}. Lorsqu'il prend la valeur « vrai », on dit d'un paramètre booléen qu'il est positionné ou défini.

Un tel paramètre booléen s'emploie uniquement ainsi dans le code d'un modèle :

{{#if: {{{booléen|}}} |<!-- alors ... (vrai) --> |<!-- sinon ... (faux) --> }}

Voici un exemple de code de documentation de ce paramètre booléen :

 :<code>booléen</code> : [[Wikipédia:Jargon/Paramètre booléen|paramètre booléen]] ; ... s'il est défini.

et un exemple d'usage dans le modèle nom du modèle :

{{nom du modèle|booléen=1}}

Les valeurs 1 ou oui sont recommandées pour "vrai". En revanche, l'utilisation de valeurs telles que 0, faux ou non sont à proscrire absolument, car elles sont ambigües voire erronées.

Voir aussi

• {{Oui non}}
• Module:Yesno

Programmation des modèles

Programmation sémantique

« Il faut favoriser la programmation sémantique »

— STyx

Il s'agit là d'un principe général (malheureusement trop abstrait et idéal)^{[réf. nécessaire]}.

Il est clair que cet objectif concerne d'abord les développeurs de Mediawiki. Toutefois, voici quelques conséquences concrètes de ce principe :

• Ne pas "jouer" avec la sémantique : Il faut choisir un modèle, non sur son apparence, mais suivant son critère d'utilisation (qui doit être en phase avec la sémantique de son titre). Par exemple, ne pas utiliser {{Infobox Archipel}} pour une ile simplement parce qu'on le préfère à {{Infobox Île}}.
• Ne pas utiliser la balise <tt> mais <code> pour la mise en forme du code.
• Éviter le recours à des modèles non sémantiques tels que {{Vert}}, {{Rouge}}, {{Grand}}, ... ; il faut préférer {{Important}}, {{Avertissement}}, {{Proposition}}, {{Erreur}}, {{Remarque}}, {{Énoncé}}, ... qui sont plus parlant.
• De la même manière, pour les codes couleur, il faut éviter vert, rouge, rose, mais à terme, construire une sémantique des couleurs (par exemple, rose pour aide, ... pour modèle, ... pour "à faire"), et un jeu de code couleurs thématiques (société, art, loisir, technologie, sport, géographie, histoire, ...).
• Il faudra également définir une sémantique des logos ; autrement dit une « signalétique thématique » (voir Aide:Signalétique, ... ^{[réf. nécessaire]})
• Préférer l'usage de "class" aux commandes de "style".
• Permettre le développement des métadonnées (voir Wikipédia:Métadonnées personne, ...^{[réf. nécessaire]})

Le principe à appliquer pour la programmation des modèles est à approcher du web sémantique : la finalité des modèles est de générer du wikicode (proche du HTML). Il s'agit d'un langage de description (le LUA est un langage de programmation) et c'est en ce sens que la sémantique doit être privilégiée. Par exemple :

une citation

<blockquote>une citation</blockquote> est à utiliser pour des citations, pas pour la marge dans l'affichage

Les métadonnées de citations pourront alors être extraites de ces balises. Par exemple : toutes les citations de tous les articles.

Codage CSS du style

Recommandation

Il faut préférer le codage CSS (avec une feuille de style) du style plutôt que son codage wiki ; autrement dit : préférer l'usage de "class" aux commandes de "style".

Note

Par « style », on entend l'apparence que prendra le modèle, sa mise en forme.

Exemple

Il faut préférer le code « <div class="error">...</div> » (avec « .error { color:red } » dans la feuille de style) au code « <div style="color:red">...</div> ».

Motivation

Limitation

Il faut toutefois veiller à conserver des feuilles de style de tailles raisonnables. Cela conduit à envisager un certain compromis notamment dans les infoboxes ; ce qui se traduit par le recours aux modèles de palette de couleurs. Cela reste à débattre.

Tableau

Recommandation

Il faut toujours employer la syntaxe HTML pour la construction de tableaux dans les modèles.

Description détaillée

Il faut employer les balises (HTML et wiki) <table>, <tr>, <td>, <th>, <caption> exclusivement (les autres balises HTML pour les tableaux n'appartiennent pas au langage wiki).

Motivation

• La syntaxe purement wiki ({- |+ ! !! |- | || |}) est totalement inadaptée aux modèles car elle emploie les mêmes caractères clés : "{" "|" "}".
• Elle est source de bogues car elle rend le code moins lisible
• Elle est moins familière et plus dure à maîtriser
• Elle n'est pas prise en charge par les modèles de type « Début Fin »
• Elle contient des bogues (un exemple)
• De plus la syntaxe HTML permet de mieux mettre en forme le code (meilleur gestion des espacements)

Voir aussi

•   Help:HTML in wikitext 
• Je ne peux pas passer un tableau en argument de modèle

Techniques de codage

Philosophie

à privilégier : clarté, adaptabilité, modularité (avec d'autres modèles), maintenabilité

(en) Pattern designs

• Template
• Facade
• Proxy
• Factory
• ...

Modèles de type switch

Exemple

{{CIO2Pays}} • {{Données/Paris/informations générales}} • {{Géolocalisation/Iran}} ...

Méta-modèles

Cette section requiert des compétences particulières en matières de programmation des modèles et en général. La croissance de la complexité des modèles fait qu'il faut se pencher sur leur optimisation.

Les questions de fond

« Premature optimization is the root of all evil (or at least most of it) in programming. »

— Donald Knuth

Le problème principal est que malheureusement, il y a un défaut d'explications et de recommandations concernant le fonctionnement de MediaWiki et ses limites : coût serveur, job queue, mémoire, cache, saturation. En l'état, il est difficile de définir les bonnes pratiques : usage du subst:, versions développées (inline), usage intensif des méta-modèles, documentation intégrée, usage de sous-modèle, pratique de recherche des troncs-communs, pratique du tout-eu-un, appels récursifs ou croisés...

Par ailleurs, il est difficile de trouver des consultants, des experts pour résoudre les problèmes techniques (les "dirty tricks").

En l'absence de recommandations de la part des développeurs de Mediawiki, il n'y a pas lieu de se soucier d'optimisation. En revanche, la modification des modèles les plus usuels est couteuse pour le serveur, il est donc recommandé d'agir alors avec circonspection sur ces modèles.

En conséquence, il faut plutôt chercher à développer l'usage des méta-modèles (ou modèles génériques) car ils simplifient la maintenance des modèles ; soit en réduisant le nombre de modèles (par la pratique du « tout en un ») ; soit en réduisant les redondances (c.-à-d., les occurrences d'un même code) (par la pratique de « recherche des tronc communs »). De plus, cela contribue à une plus grande harmonisation de l'apparence graphique. Par ailleurs, le développement de modèles génériques est simplement la manière saine de programmer.

Il semble que le surcout général du à l'usage des méta-modèles soit, sinon nul, du moins négligeable (grâce au cache (+job queue) ; « les modèles sont "précalculés" »). En revanche le remaniement d'un méta-modèle (usuel) à un cout important, il doit donc être protégé et en quelque sorte "verrouillé" :

Plus un modèle est générique et donc usité, moins il doit être remanié. En conséquent, un méta-modèle doit être conçu de manière quasi-définitive, et suffisamment souple,

puis être protégé.

Voir aussi

•   Wikimedia cache strategy evolution during 2003 

---

Ainsi, les avantages des méta-modèles en termes d'harmonisation et de simplicité d'usage sont clairs et justifient largement leur généralisation. On doit donc favoriser (sans excès) ces deux pratiques (tantôt complémentaires ou antagonistes) :

Pratique de « recherche des troncs communs »

C'est la pratique de recherche des fonctions primitives ("recherche de généricité") dont le principe est : « rassembler les troncs communs du code dans des modèles génériques ». Il s'agit là d'un processus naturel en programmation qui consiste à créer une librairie logicielle.

L'un des rôles de ces modèles est d'encapsuler les aspects techniques, les syntaxes difficiles (c'est le cas des modèles balises "Début" "Fin", de {{Lien avec icône}}, {{Wikilien}}, des briques d'infobox etc.)

Cette pratique entraine l'utilisation d'un grand nombre de sous-modèles (autrement dit, des modèles pour modèles ; et il est bien venu de les mettre en sous-pages puisque cela est désormais pleinement accepté).

Cela est donc conseillé pour construire des sous-modèles, non des modèles d'usage encyclopédique. Ainsi le principe de conception des Chimiebox (une dizaine de modèles pour une infobox !) n'est pas souhaitable.

Toutefois, la mise en cascade (l'imbrication) de modèles est déjà limitée par le serveur. Alors, un message d'erreur apparait et la page ne se charge plus entièrement.

En effet, l’expansion des modèles se fait évaluant de façon inconditionnelle tous les paramètres, même quand ceux-ci ne sont pas tous utilisés, et la réduction du code conditionnel inutile se fait ensuite ; il peut s’en suivre une surcharge en mémoire pour certains modèles qu’il faut alors optimiser pour éviter un dépassement de capacité.

C'est une limite actuelle de MediaWiki qui ne sait pas encore procéder à une évaluation entièrement paresseuse pour l’expansion des seuls paramètres qui sont strictement nécessaires, et qui pourrait de plus garder en cache lors de l’évaluation d’une page les différents appels de modèles ayant des paramètres identiques, pour que ceux-ci produisent les mêmes résultats sans avoir à les réévaluer complètement à chaque réutilisation).

De plus MediaWiki inclue complètement le modèle dans la page avant d’éliminer à la fin seulement le code en <noinclude> au lieu de gérer un cache séparé pour l’utilisation en "includeonly" (avec l’expansion et l’évaluation des paramètres déjà effectuée, séparément des appels avec paramètres non préétenus et non prévalués) et l’utilisation en "noinclude" (affichage direct de la page de documentation).

En définitive, il reste toujours aisé (dans de tels cas de figure) de "#subst:ituer" le(s) sous-modèle(s) tout en conservant le principe de conception (un usage virtuel de sous-modèle, en quelques sortes, semblable au code inline de C++).

Exemples de tels modèles

{{Coord}} • {{Géolocalisation}} (sous-modèles passés en argument) • modèles de type #switch...

Pratique du « tout en un »

La pratique du « tout en un » consiste à dire « un seul modèle pour tous les cas de figure (même les plus singuliers) ». Cette pratique crée des modèles complexes qui ont un grand nombre de paramètres souvent inemployés.

Il ne faut pas que cela se fasse aux dépens de la facilité de codage avec des millions de {{#if: ...}} qui s'emboitent les uns dans les autres. De manière similaire, les paramètres doivent être facultatifs et non optionnels ; ou autrement dit, les paramètres doivent être indépendant les uns des autres. Ainsi, parler de « cas de figures » dans la documentation est le signe d'une mauvaise conception du modèle.

Enfin, atteindre une centaine de paramètres serait excessif.

Exemples de tels modèles

{{BUtilisateur}} • {{Infobox Subdivision administrative}} • {{Ouvrage}} • {{Article}} ou {{Coord}} (dans une moindre mesure)

Vers une hiérarchie de classes

Un méta-modèle s'apparente à une classe parent (héritage des paramètres, du code, de l'apparence). De même, le concept de hiérarchie de classes se retrouve dans les classes de CSS (C=cascading).

Cette notion est donc à prendre en compte pour une conception plus saine des modèles.

Infoboxes

Syntaxe de la première colonne

Convention

Il faut utiliser la syntaxe <th>, "!" en code wiki, suivi de scope="col" (et non la syntaxe <td>, "|") pour la première colonne des infoboxes.

Motivation

• Cela permet une différenciation plus aisée du style des colonnes dans les CSS.
• C'est la syntaxe appropriée (d'un point de vue sémantique).

Gestion des paramètres manquants

Plusieurs techniques sont possibles lorsqu'un paramètre (disons param) n'est pas fourni :

technique du "#if:"

{{#if: {{{param|}}} 
 |...
}}

• Avantage: fiabilité
• Inconvénient: syntaxe très délicate

Souplesse

Il s'agit ici d'étudier des moyens d'apporter de la souplesse aux infoboxes.

Infobox générique

Une Infobox générique est un modèle qui peut inclure plusieurs types de thématiques. Comme par exemple {{Infobox Musique (artiste)}}, qui peut apparaître sur l'article d'un soliste, duo, trio, groupe, instrumentiste, ensemble classique, etc. Chacun de ces thèmes peut avoir sa propre charte graphique et des paramètres que l'on interchange dépendamment du thème.

Les avantages sont l'harmonisation, la réduction des Infoboxes pour un même thème, le rapatriement des paramètres similaires au sein d'un même modèle, la simplicité pour les néophytes.

Appel d'un modèle

L'appel d'un modèle se fait en mettant le nom du modèle entre accolades {{}} en ajoutant les paramètres nommés ou non nommés séparés d'un pipe |.

Exemples pour le modèle MonModèle :

• {{MonModèle|paramètre1=...|paramètre2=...|paramètre3=...}} (paramètres nommés)
• {{MonModèle|paramètre1|paramètre2|paramètre3}} (paramètres non nommés)

Recommandations :

• il n'est pas nécessaire et non souhaitable d'y incorporer le nom de domaine, ne pas écrire : {{modèle:MonModèle|paramètre1|paramètre2|paramètre3}}.
• mettre de préférence une majuscule à la première lettre du modèle : préférer {{MonModèle}} à {{monModèle}}

Pour certains modèles, comme les Infobox, il est préférable de ne pas utiliser cette syntaxe compacte. Lui préférer :

{{MonModèle
 | paramètre1 = ...
 | paramètre2 = ...
 | paramètre3 = ...
}}

Dans ce cas respecter les consignes suivantes :

• mettre le | en début de ligne, jamais en fin de ligne
• mettre au minimum un espace avant le signe =
• mettre un et un seul espace après le signe =

Lorsque certains paramètres sont liés, il pourront être mis sur une ligne, par exemple :

|paramètre3.1 = ... |paramètre3.2 = ... |paramètre3.3 = ...

---