Projet:Modèle/Harmonisation
Un article de Wikipédia, l'encyclopédie libre.
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...
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. Concernant les infoboxes, voir modèle de fiche.
Sommaire |
[modifier] 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éirons à la même convention des titres que les Infoboxes; par exemple {{Palette Nom de la palette}}
Évitons ici de reformuler toutes ces conventions. On se borne ici à mettre la doigt sur certains "mauvais plis" et à rectifier certains points :
[modifier] 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
- Catégorie:Palette de navigation devient Catégorie:Modèle de palette de navigation ou simplement Catégorie:Modèle de palette
- Catégorie:Méta-modèle devient Catégorie:Modèle générique
[modifier] 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.
[modifier] 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». Noter l'incohérence ; puisque le titre correct doit donc logiquement être{{Infobox Province Maroc}}
{{Infobox de province du Maroc}}
.
[modifier] Modèles génériques
L'usage du préfixe "
Méta <minuscule>...
" est recommandé pour les modèles génériques.
[modifier] 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}}
[modifier] 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)/menu/encadré/boîte/tableau • (modèle de) lien, ...
[modifier] 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 sont assimilés à de palette. 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.
[modifier] 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 page non-encyclopédiques.
[modifier] 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.
- Note
- Une infobox est une généralisation d'une taxobox qui fait la somme des informations pour un organisme ou un groupe d'organismes.
[modifier] Fiche
Un modèle de fiche est un modèle infobox qui obéit à des conventions sévères, de création, de formatage et de paramètrage (à définir) afin d'être exploitable en tant que métadonnées (en savoir plus). Il est souhaitable que les infobox deviennent à terme des fiches. « Fiche » signifie donc : (prototype d') « Infobox nouvelle génération ».
- Note
- La notion de fiche est donc au stade du prototype. Il s'agit donc d'une infobox conforme aux normes établies (/à établir) dans cette page.
[modifier] 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 surement 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.
Un 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 discussion, il est utile de faire une synthèse. Autrement dit, il ne faut pas que l'Infobox (ou la Fiche) 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.
[modifier] Nom des paramètres
[modifier] 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' "accollement" (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)
- Notes
- {{Ouvrage}} utilise
isbn
,issn
plutôt que ISBN, ISSN - {{Lien web}} utilise
url
plutôt que URL
[modifier] Usage du "_"
Ne pas employer de "_" 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 ne pas initié à ces "façons" de programmeur
- Note
- l'usage courant étant apparemment 50-50, la proposition devrait donc faire l'objet d'une prise de décision.
[modifier] 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 valeur sont en anglais), ...
- Motivation
-
- l'usage de 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.
[modifier] Valeur des paramètres
[modifier] Recommandations générales pour la valeur des paramètres
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 permet 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.
[modifier] 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 • image • lien • taille • texte • contenu • pays • population • style ...
[modifier] 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
- {{Infobox Volcan}} employait
coordonnées
. - {{Commune italienne}} utilise
latitudegrade
(grade ... hallucinant!)latitudeminute
,latitudeseconde
- {{Infobox Phare}} a deux paramètres
position
,localisation
et s'emploie ainsi (Phare de la Lande) :
-
-
|position={{Coor dms|48|38|14|N|03|53|09|W|scale:2000_region:fr}}
-
- 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 sous forme décimale (un "
.
" pour la virgule) entre -90 et 90 (en savoir plus).
[modifier] pays
- Convention
La valeur du paramètre
pays
doit être un simple nom de pays (pas de lien) dont le nom est recensé dans Catégorie:Modèle pays et drapeau.
- Particularité
- Les Catégorie:Modèle pays et drapeau historique peuvent être employés dans certains cas (dommaine 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 "[[Iran]]" permet la géolocalisation et l'usage de {{Iran}} : Iran.
[modifier] 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
{{Infobox Musique (artiste)/Charte couleurs}} (rectifié)
- Convention
La valeur d'un paramètre de couleur doit être conforme à la syntaxe HTML pour les couleurs (en savoir plus).
[modifier] style
- Convention
Le paramètre
style
correspond à l'attributstyle
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.
[modifier] image
[modifier] 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 {{!}}.
[modifier] titre
[modifier] 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.
[modifier] 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
ououi
sont recommandées) (vrai) (en savoir plus).
[modifier] Programmation des modèles
[modifier] 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])
[modifier] 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.
[modifier] 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 BUG car elle rend le code moins lisible
- Elle est moins familière et plus dure à maitriser
- Elle n'est pas supportée par les modèles de type "Début Fin"
- Elle contient des BUG (un exemple)
- De plus la syntaxe HTML permet de mieux mettre en forme le code (meilleur gestion des espacements
- La syntaxe purement wiki (
- Voir aussi
[modifier] Techniques de codage
(en) (pattern design)
[modifier] Modèles de type switch
- Exemple
- {{CIO2Pays}} • {{Infobox Musique (artiste)/Charte couleurs}} • {{Cadre1/Couleur}} • {{Géolocalisation/Iran}} ...
[modifier] Méta-modèles
Cette section requiert des compétences particulières en matières de programmation des modèles et en générale. La croissance de la complexité de modèles fait qu'il faut se pencher sur leur optimisation.
[modifier] Les questions de fond
« Premature optimization is the root of all evil (or at least most of it) in programming. » |
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écurcifs 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.
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 nombres 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 surcoût 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" » ).
- Voir aussi
- Wikimedia cache strategy evolution during 2003 (faute de mieux, hélas)
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) :
[modifier] Pratique de « recherche des tronc 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.
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 de Chimiebox (une dizaine de modèle 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 de façon en évaluant de façon inconditionelle en entièrement tous les paramètres, même quand ceux-ci ne sont pas tous utilisés, et la réduction du code coditionnel 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" (affiche 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
- {{Fiche}} • {{Coord}} • {{Géolocalisation}} (sous-modèles passés en argument) • modèles de type
#switch
• ...
[modifier] 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}} • Projet:Modèle/Fiche ville • {{ouvrage}} • {{périodique}} ou {{Coord}} (dans une moindre mesure)
[modifier] Vers une hiérarchies 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érarchies de classes se retrouve dans les classes de CSS (C=cascading).
La hiérarchie des classes est plus particulièrement évidente pour les fiches (substitut des infoboxes) : "Fiche Ville Canada" dérive/hérite (conceptuellement sinon dans la pratique) de "Fiche Ville" qui dérive de "Fiche Lieu" (tout ce qui est "géolocalisable") dérive de "Fiche".
Cette notion est donc à prendre en compte pour une conception plus saine des modèles.
[modifier] Infoboxes
[modifier] Syntaxe de la première colonne
- Convention
Il faut utiliser la syntaxe
<th>
, "!" en code wiki, (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).
[modifier] 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
- technique du "hiddenStructure"
- Voir {{Infobox Opéra (œuvre)}} par exemple.
class="{{{param|hiddenStructure}}}"
- Avantage: simplicité du code
- Inconvénient: mauvais bricolage ; alourdi inutilement le code généré par le serveur
- Recommandation: à n'employer que pour des paramètres dont les valeurs sont très simples et "sans surprises" (valeurs numériques, par exemple)
[modifier] Souplesse
Il s'agit ici d'étudier des moyens d'apporter de la souplesse aux infoboxes.
[modifier] 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épendemment 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.
[modifier] le problème de Corvo (Açores) (2 en 1)
{{Aide}} Ce bandeau est réservé à la prévisualisation ; si vous souhaitez le conserver. mettez-le en commentaire.
rechercher p parmi les projets - portails - catégories |
Modèle : • • listes |