- Projet:JavaScript
-
Projet Fonctions disponibles Notices Discussion projet Signaler un bug Demander une nouvelle fonction Projet JavaScriptCe projet essaie de centraliser les fonctions JavaScript pour éviter la dispersion du code. Utiliser une fonction
Pour bénéficier d'une des fonctionnalités présentées par le projet, vous pouvez posséder un compte utilisateur sur Wikipédia.
Vous pouvez consulter la liste des fonctions disponibles pour connaître la liste des codes disponibles et les procédures d'installation.
Personnaliser une fonction
Certaines fonctions sont paramétrables. Vous pouvez visualiser le code source (par l'onglet modifier). Si vous trouvez une section délimitée par des balises comme /////ZONE PERSONNALISABLE/////, vous pouvez recopier et adapter cette partie dans votre page monobook en personnalisant les variables dans une fonction que vous ajoutez aux fonctions appelées après chargement de la page (fonction addOnloadHook).
Les paramètres modifiables peuvent être présents dans les notices d'utilisation.
Exemple :
obtenir('GoogleSearch'); function personnaliserGoogleSearch(){ googlesearchPrefix = "fr"; } addOnloadHook( personnaliserGoogleSearch );
On peut créer une fonction de personnalisation par script utilisé, ou créer une seule fonction de personnalisation pour tous les scripts utilisés.
Si vous avez des doutes quant à votre personnalisation, vous pouvez demander un conseil sur la page Discussion Projet:JavaScript.
Signaler un bug
Pour signaler un bug concernant une fonction existante, vous pouvez utiliser la page Discussion Projet:JavaScript/Rapport de bug.
Pour une meilleure chance d'obtenir une réponse rapide, pensez à préciser la fonction incriminée, votre configuration (navigateur), ainsi que les circonstances amenant l'apparition du bug.
Demander la création d'une fonction
Pour obtenir une fonction inexistante, vous pouvez faire une demande sur la page Discussion Projet:JavaScript/Demande de fonction.
Des utilisateurs expérimentés pourront vous répondre sur la faisabilité de votre demande et si possible créeront une fonction prête à l'emploi.
Autres requêtes
Pour tout autre demande, vous pouvez vous rendre sur la page de discussion du projet.
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 WP:DIMS.
- Variables permettant de personnaliser la fonction :
- Elles sont déclarées hors de tout contexte (voir schéma ci-dessous).
- 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>
Aide aux développeurs
- Projet:JavaScript/Aide personnalisation (Personnaliser une fonction, aide détaillée)
- Projet:JavaScript/Aide Ajax (Utiliser Ajax et l'objet XMLHttpRequest pour faire des requêtes au serveur)
- Projet:JavaScript/Aide API (Utiliser l'API de mediaWiki, aide détaillée)
- Projet:JavaScript/Développeurs (structures des pages Wikipedia, équivalences de classes et d'id suivant le skin)
- Projet:JavaScript/Fonctions globales de mediaWiki (Fonctions javascript globales de MediaWiki)
- Projet:JavaScript/Outils (Outils/Liens utiles aux programmeurs)
- Projet:JavaScript/Notices (Notices des gadgets existants)
- Projet:JavaScript/Aide WikiEditor (Aide sur la nouvelle barre d'édition)
Catégories :- Projet:JavaScript
- Maintenance des pages MediaWiki
Wikimedia Foundation. 2010.