MediaWiki:Gadget-DevTools/Documentation

Un livre de Wikilivres.
Sauter à la navigation Sauter à la recherche

Ce gadget ajoute un lien "outils de script", par défaut en haut de la page après le lien de déconnexion. Ce lien permet d'ouvrir une console permettant de tester du code Javascript. Il permet donc d'utiliser les variables et fonctions Javascript définis pour ce site afin de pouvoir effectuer des tests.

Ce gadget inclut le gadget journal de débogage car il permet également de le ré-ouvrir s'il contient des messages.

Installation

Pour installer le gadget, cochez la case "DebugTools : Ajouter un lien pour accéder aux outils de développement de scripts (voir la documentation)." dans l'onglet "gadgets" de vos préférences.

Utilisation

Pour ouvrir la fenêtre cliquez le lien "outils de script".

La fenêtre comporte :

  • une zone de saisie de code Javascript à gauche,
  • une zone en lecture seule à droite pour afficher le résultat de l'exécution du code,
  • un bouton rouge en haut à droite pour fermer la fenêtre,
  • un bouton "Exécuter" pour exécuter le code saisi et afficher le type et la valeur du résultat à droite (en cas d'erreur, le résultat est affiché en rouge),
  • un bouton "Effacer",
  • optionnellement un bouton "xx messages" permettant d'afficher le journal de débogage. Ce bouton ne s'affiche pas si le journal de débogage est vide.

Fonctions utiles

Certaines fonctions facilite le débogage des scripts et peuvent être utilisées dans la console Javascript :

devdebug(message)
Cette fonction ajoute un message au journal de débogage, et peut être utilisée par tout gadget ou script temporairement pour afficher l'état de certaines variables.
devdump(valeur)
Cette fonction retourne le type exact et le détail du contenu d'un objet, d'un tableau, d'une valeur ou le code source d'une fonction (si le navigateur le permet).
devdumptree(valeur)
Cette fonction retourne le type exact et le détail du contenu d'un objet, d'un tableau, d'une valeur ou le code source d'une fonction (si le navigateur le permet), de manière récursive, sous la forme d'un arbre (indentation du texte). Cette fonction sert à afficher les objets et arbres imbriqués (tableaux ou objets contenant d'autres tableaux ou objets).

Maintenance

Ce gadget peut servir à la maintenance de données générées périodiquement.

Voir : MediaWiki:Gadget-DevTools/Code.