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, vous pouvez demander l'insertion ou la modification d'un script sur A&L:DIMS.
- Variables permettant de personnaliser la fonction :
- Elles sont déclarées hors de tout contexte (voir schéma ci-après).
- 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
- Les tabulations valent 8 caractères et l'indentation est propre.
- Les points-virgule en fin d'instructions devraient être mis de préférence.
- La balise source permet une meilleure lisibilité, cf. exemple.
- Penser à catégoriser la page.
- Schéma type :
Exemple
/**
* Toto
*
* La fonction Toto ne sert à rien du tout
*
* Auteurs :
* Date de dernière révision :
*/
// Documentation de la fonction Toto :
// Il n'y en a pas
//////////////////////ZONE PERSONNALISABLE//////////////////////
var totoVariablePersonnalisable = 42;
/////////////////FIN DE LA ZONE PERSONNALISABLE/////////////////
function Toto() {
var interne = false;
// cette fonction ne sert à rien
totoVariablePersonnalisable ++;
interne = !interne;
}
addOnloadHook(Toto);
Zone personnalisable
La zone personnalisable est signalée entre les deux lignes de commentaires suivantes :
//////////////////////ZONE PERSONNALISABLE//////////////////////
et
/////////////////FIN DE LA ZONE PERSONNALISABLE/////////////////
Cette zone ne doit contenir que des variables.
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>
.