Extension:Survey

Manuel des extensions MediaWiki

Survey État de la version : expérimental
Implémentation	Page spéciale , API , Interface utilisateur, Ajax
Description	Survey est une extension MediaWiki permettant aux administrateurs de créer des sondages qu'on peut alors soumettre à un groupe spécifié d'utilisateurs.
Auteur(s)	Jeroen De Dauw
Maintenance	WikiTeq team
Dernière version	0.3.0 alpha (2014-04-02)
Politique de compatibilité	Pour chaque version de MediaWiki qui est une version avec support à long terme (LTE - Long Term Support) il existe une branche correspondante dans l'extension.
MediaWiki	1.39
PHP	7.0+
Modifie la base de données	Oui
Licence	Licence publique générale GNU v2.0 ou supérieur
Téléchargement	Télécharger l'extension Git [?]: Télécharger la branche master de Git parcourir le dépôt (Phabricator · GitHub) historique des validations (commits) contributeurs du dépôt (GitHub) relecture du code README
Paramètres $wgSurveySettings
Droits ajoutés surveyadmin surveysubmit
Accroches utilisées LoadExtensionSchemaUpdates UnitTestsList ParserFirstCallInit ArticleViewHeader AdminLinks
Téléchargements trimestriels	3 (Ranked 139th)
Traduire l’extension Survey sur translatewiki.net si elle y est disponible
Problèmes	Tâches ouvertes · Signaler un bogue

L'extension Survey permet administrateurs de créer des sondages qu'on peut alors soumettre à un groupe spécifié d'utilisateurs. Il n'est fonctionnel sur aucune version actuellement supportée de MediaWiki.

Vue d'ensemble des fonctionnalités

• les sondages sont présentés aux utilisateurs du wiki à l'aide d'un beau formulaire surgissant.
• On peut créer des sondages et les modifier à l'aide d'un tableau de bord administratif (Special:Surveys).
• On peut présenter les sondages à des types d'utilisateurs spécifiques (logés, anonymes, éditeur, confirmé, ...)
• On peut présenter les sondages à un pourcentage défini d'utlisateurs, et seulement après une certaine quantité de pages visitées.
• Les questions des sondages peuvent avoir différents types d'entrées, dont certaines autorisent à restreindre les réponses.
• Les administrateurs peuvent tester les sondages grâce à Special:TakeSurvey sans que ceux-soient activés dans le wiki.
• On peut accéder à un résumé des réponses aux sondages à Special:SurveyStats.
• les données soumises au sondages (i.e. les réponse des utilisateurs) peuvent être exportées à l'aide d'une API.

Installation

• Téléchargez et placez le(s) fichier(s) dans un répertoire appelé Survey dans votre dossier extensions/.
  Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Survey
• Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :

  wfLoadExtension( 'Survey' );
  

• Exécutez le script de mise à jour qui va créer automatiquement les tables de base de données dont cette extension a besoin.
• Configurez au besoin.
•  Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Configuration

On configure Survey en affectant une valeur à la variable $egSurveySettings dans son fichier LocalSettings.php . Les options sont listées ci-dessous et leurs valeurs par défaut sont déclarées dans le fichier des réglages de Survey.

Il ne faut PAS modifier le fichier de réglages, mais l'examiner pour voir comment utiliser ces réglages, dans le cas où les descriptions ci-dessous seraient insuffisantes.

Voici des exemples de façon de modifier un réglage :

$egSurveySettings['defaultEnabled'] = true;

Réglages disponibles :

Nom	Type	Valeur par défaut	Description
defaultEnabled	boolean	false	Faut-il activer les sondages par défaut
defaultUserType	Survey::$USER_	Survey::$USER_ALL	Type d'utilisateurs par défaut à qui montrer les sondages
defaultNamespaces	array	array()	Espace de nom par défaut dans lequel les sondages doivent apparaître. Une liste vide signifie pas de restriction d'espace de nom.
defaultRatio	integer	100	Pourcentage par défaut des utilisateurs à qui présenter le sondage
defaultExpiry	integer	60 * 60 * 24 * 30	Expiration par défaut des cookies utilisés pour tracer le remplissage des sondages par les utilisateurs, en secondes
defaultMinPages	integer	0	Minimum de pages par défaut qu'un utilisateur visite avant de faire le sondage
JSDebug	boolean	false	Indique si le débogage de JavaScript doit être activé ou non. Doit être réglé à faux dans un environnement de production.

Utilisation

Cette section est destinée aux administrateurs de site qui veulent créer et maintenir des sondages. Pour les utilisateurs l'utilisation des sondages est censé être intuitif.

Création et rédaction de sondages

On peut créer, rédiger et détruire des sondages à Special:Surveys quand on dispose du droit 'survey admin', accordé aux sysops par défaut seulement.

Test des sondages

On peut tester les sondages en cliquant sur le nom du sondage ou sur "take this survey" dans l'interface d'administration. Cela va à la page Special:TakeSurvey, qu'on peut utiliser pour tester le fonctionnement de sondages. On peut renvoyer le sondage aussi souvent qu'on veut. Seuls les utilisateurs avec le droit 'survey admin' ont accès à cette page.

Déploiement des sondages

UNe fois qu'un sondage est activé, il est déployé dans la totalité du wiki pour tous les utilisateurs satisfaisant aux critères. Ces utilisateurs devront alors visiter un nombre minimum de pages avant que le sondage ne soit activé, et à ce moment un tirage au sort est effectué, pour assurer qu'un pourcentage spécifié d'utilisateurs passe le sondage.

Si on veut au contraire déployer un sondage sur une ou plusieurs pages spécifiques, il faut inclure le tag ‎<survey> dans chacune. Il faut l'appeler de la façon suivante :

<survey id="" ratio="" expiry="" min-pages="" />

l'ID doit correspondre à l'ID du sondage, qui est la chaîne apparaissant après "Special:TakeSurvey/". Les autres attributs correspondent chacun à des réglages de Special:EditSurvey.

Notez bien que l'utilisation du tag 'survey' est expérimentale et pourrait ne pas fonctionner dans certaines situations.

Garder un trace des sondages

On peut trouver un résumé des sondages à Special:SurveyStats, qui est lié à l'interface d'administration. Cette page n'est accessible qu'aux utilisateurs disposant de la permission 'survey admin'.

Exportation des données à l'aide de l'API

Survey permet d'exporter les sondages et les données des réponses à l'aide de l'API de MediaWiki avec ces trois modules d'API :

• ApiQuerySurveys — récupère les sondages correspondant aux conditions données — api.php?action=query&list=surveys&suids=4|2
• ApiQuerySurveySubmissions — récupère les réponses d'un sondage — api.php?action=query&list=surveysubmissions&qsid=42
• ApiQuerySurveyAnswers — récupère les réponses (une pour chaque champ de donnée dans un envoi) — api.php?action=query&list=surveyanswers&qaid=42

Ces modules permettent de demander des données seulement pour les utilisateurs disposant du droit de 'surveyadmin'. La documentation complète de ces modules d'API peut être trouvée à api.php dans votre wiki.

Version

La version 0.3.0 alpha est la tentative de rendre cette extension compatible avec MediaWiki 1.23+.

Les notes de version dans Git ne couvrent que les versions jusqu'à la 2.0 à ce point.

Internationalisation

Survey internationalisé complètement. La traduction de messages de Survey se fait à l'aide de translatewiki.net. On peut trouver la traduction pour cette version ici. Pour ajouter des langues ou modifier celles qui existent, il faut créer un compte sur translatewiki.net, puis demander la permission des administrateurs pour traduire une certaine langue ou certain groupe de langues à cette page (c'est un processus très simple). Une fois qu'on la permission pour une langue, on peut se connecter et ajouter ou modifier n'importe quel message dans cette langue.

Auteurs

Survey a été écrit par Jeroen De Dauw en tant que WikiWorks consultant pour the IEEE.

Captures d'écran

• 
  Special:Surveys liste des sondages existants
• 
  Special:EditSurvey est l'interface de rédaction des sondages
• 
  Les sondages sont affichés comme des fenêtres surgissantes aux utilisateurs, et peuvent être testés à Special:TakeSurvey
• 
  Des résumés au sujet de réponses aux sondage peuvent être trouvés à Special:SurveyStats