Aller au contenu

Projet:Scripts et gadgets/Recommandations

Une page de Wikipédia, l'encyclopédie libre.

Recommandations aux développeurs

Intégration

  • Les fonctions sont dans des pages qui commencent par MediaWiki:Gadget- et se terminent par .js. Il faut l'extension .js (pour être compatible avec l'extension Gadgets), la liste complète de ces pages est donc accessible via Special:Prefixindex/MediaWiki:Gadget- (et choisissez celles qui se terminent par .js). Si vous n'êtes pas administrateur d'interface, vous pouvez demander l'insertion ou la modification d'un script sur Wikipédia:Demande d'intervention sur un message système (raccourci : WP:DIMS).
  • Variables permettant de personnaliser la fonction :
    • Elles sont déclarées hors de tout contexte (voir schéma dans le bloc #Personnaliser une fonction).
    • Elles ont un nom discriminatoire et préfixé par le nom de la fonction principale, ceci afin d'éviter les mélanges avec d'autres fonctions.

Présentation préférentielle du code

Tous les javascripts des wikis sont censés suivre MW:Manual:Coding conventions/JavaScript. De plus, ici :

  • Les tabulations valent 4 caractères et l'indentation est propre.
  • Les points-virgules en fin d'instructions doivent être présents.
  • Penser à catégoriser la page.

Catégorisation

La catégorisation d'un code s'effectue de préférence via le modèle {{Catégorisation JS}} insérée en commentaire en dehors d’éventuelles balises <source>, <pre> ou <nowiki>.