扩展:调查

**MediaWiki扩展手册**
Survey; 发行状态：试验版
实现	特殊页面, API, 用户界面, Ajax
描述	Survey is a MediaWiki extension that allows administrators to define surveys that can then be shown to specified groups of users.
作者	Jeroen De Dauw
维护者	WikiTeq team
最新版本	0.3.0 alpha (2014-04-02)
兼容性政策	对于每个有长期支持的MediaWiki发行版本，扩展内都有对应的分支。
MediaWiki	1.39
PHP	7.0+
数据库更改	是
许可协议	GNU通用公眾授權條款2.0或更新版本
下載	下載扩展 ; Git [?]: 下载Git master; 浏览存储库 (Phabricator · GitHub); 提交历史; 存储库貢獻者 (GitHub); 代码复核; ; README
	参数 $wgSurveySettings;
	添加权限 surveyadmin; surveysubmit;
	使用的函数钩 LoadExtensionSchemaUpdates; UnitTestsList; ParserFirstCallInit; ArticleViewHeader; AdminLinks;
季度下載量	3 (Ranked 133rd)
	前往translatewiki.net翻譯Survey扩展
問題	开启的任务 · 报告错误

This page is a translated version of the page Extension:Survey and the translation is 35% complete.

This extension is professionally maintained by the WikiTeq team.

WikiTeq provides official support for MediaWiki LTS releases only. It may work with other MediaWiki releases.

The Survey extension allows administrators to define surveys that can then be shown to specified groups of users. It is not functional on any currently supported version of MediaWiki.

功能概览

Surveys get displayed to wiki users using a nice pop-up form.

Surveys can be created and modified via an admin panel (Special:Surveys).

Surveys can be shown to specific types of users (logged in, anonymous, editor, confirmed, …)

Surveys can be shown for a specified percentage of users, and only after a certain amount of page views.

Survey questions can have different types of inputs, of which some allow restricting answers.

Surveys can be tested by admins via Special:TakeSurvey without them being live on the wiki.

Summaries of survey submissions can be found on Special:SurveyStats.

The survey submission data (i.e. user answers) can be exported via an API.

安裝

下载文件，并将解压后的Survey文件夹移动到extensions/目录中。
开发者和代码贡献人员应从Git安装扩展，输入：cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Survey
将下列代码放置在您的LocalSettings.php 的底部：
```
wfLoadExtension( 'Survey' );
```
运行更新脚本，它将自动创建此扩展必须依赖的数据库表。
按需求配置。
完成 – 在您的wiki上导航至Special:Version，以验证已成功安装扩展。

配置

Configuration of Survey is done by assigning to $egSurveySettings in your LocalSettings.php file. The options are listed below and their default is set in the Survey settings file.

You should NOT modify the settings file, but can have a look at it to get an idea of how to use the settings, in case the below descriptions do not suffice.

改变设置的例子：

$egSurveySettings['defaultEnabled'] = true;

可用的设置：

名称	类型	默认	描述
defaultEnabled	boolean	false	If surveys should be enabled by default
defaultUserType	Survey::$USER_	Survey::$USER_ALL	The default type of users a survey is shown to
defaultNamespaces	array	array()	The default namespaces in which surveys should be shown. Empty list for no namespace restrictions
defaultRatio	integer	100	The default percentage of users the surveys should be shown to
defaultExpiry	integer	60 * 60 * 24 * 30	The default expiry of cookies used to track survey completion of users, in seconds
defaultMinPages	integer	0	The default minimum amount of pages users should visit before getting a survey
JSDebug	boolean	false	Indicates if JavaScript debugging should be on or not. Should be false on production environments.

用法

This section is targeted at site admins that want to set up and manage surveys. For users the process of taking a survey should be self-explanatory.

创建和编辑调查

Surveys can be created, edited and removed in Special:Surveys by people with the survey admin right, by default only sysops.

测试中的调查

Surveys can be tested by clicking the survey name or "take this survey" in the admin UI. This takes you to Special:TakeSurvey, which can be used to test survey submissions. You will be able to submit as many times as you want. Only people with the survey admin right can access this page.

部署调查

Once a survey is enabled, it gets deployed wiki-wide for all users matching the user criterion. These users will then need to visit the minimum amount of pages before the survey gets activated, at which point a lottery is done, making sure only the specified percentage of these users gets the survey.

If you want to instead deploy a survey on one or more individual pages, you can embed the ‎<survey> tag in each one. It is called in the following way:

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

The ID should match the survey's ID, which is the string that shows up after "Special:TakeSurvey/". The other attributes each correspond to settings found in Special:EditSurvey.

Do note that using the survey tag is an experimental feature which might not work properly in all situations.

对调查进行跟踪

A summary of survey results can be found on Special:SurveyStats, linked from the admin UI. This is only accessible by people with the survey admin right.

通过API导出数据

Survey allows you to export surveys and submission data via the MediaWiki API using these 3 API modules:

ApiQuerySurveys — get the surveys matching the provided conditions — api.php?action=query&list=surveys&suids=4|2

ApiQuerySurveySubmissions — get the submissions for a survey — api.php?action=query&list=surveysubmissions&qsid=42

ApiQuerySurveyAnswers — get the answers (there is 1 for each field in a submission) — api.php?action=query&list=surveyanswers&qaid=42

These modules can only be used to query data by people that have the surveyadmin right. Full documentation for these API modules can be found at api.php on your wiki.

版本

Version 0.3.0 alpha is the attempt to bring this extension to compatibility with MediaWiki 1.23+.

The release notes in Git only cover up to version 2.0 at this point.

国际化

Survey is fully internationalized. Translation of Survey messages is done through translatewiki.net. The translation for this extension can be found here. To add language values or change existing ones, you should create an account on translatewiki.net, then request permission from the administrators to translate a certain language or languages on this page (this is a very simple process). Once you have permission for a given language, you can log in and add or edit whatever messages you want to in that language.

作者

Survey has been written by Jeroen De Dauw as WikiWorks consultant for the IEEE.

截图

Special:Surveys listing the available surveys
Special:EditSurvey is the editing interface for surveys
Surveys are displayed to users as a pop-up screen, and can be tested on Special:TakeSurvey
Summaries of survey submissions can be found on Special:SurveyStats