Extension:SignupAPI: Difference between revisions
Appearance
Content deleted Content added
SPage (WMF) (talk | contribs) link to E3Experiments and relevant gerrit change |
No edit summary |
||
| (11 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{archived extension|3104209|reason=broken extension and unavailable files, the only ones that are in the github repository is for mediawiki 1.19 and does not support recent versions of mediawiki}} |
|||
{{Extension |
|||
|name = SignupAPI |
|||
|status = experimental |
|||
|type1 = user activity |
|||
|type2 = ajax |
|||
|type3 = special |
|||
|type4 = api |
|||
|type5 = hook |
|||
|type6 = database |
|||
|hook1 = LoadExtensionSchemaUpdates |
|||
|hook2 = SignupForm |
|||
|username = Akshay.agarwal |
|||
|author = <!-- add only if different from user name --> |
|||
|description = It creates a special page that cleans up SpecialUserLogin from signup related stuff, adds an API for signup, adds sourcetracking for account creation & AJAX-ifies the signup form |
|||
|version = 1.0 |
|||
|mediawiki = 1.19 |
|||
|php = 5.0 |
|||
|needs-updatephp = yes |
|||
|license = GPL |
|||
|download ={{WikimediaDownload|SignupAPI}} |
|||
|parameters = $wgSignupAPIUseAjax, $wgSignupAPISourceCreation |
|||
|bugzilla = SignupAPI |
|||
}} |
|||
==What can this extension do?== |
|||
It creates a special page that cleans up SpecialUserLogin from signup related stuff, adds an API for signup, adds sourcetracking for account creation & AJAX-ifies the signup form. |
|||
==Installation== |
|||
To install this extension, copy the entire SignupAPI directory to your extensions directory |
|||
Add the following to [[Manual:LocalSettings.php|LocalSettings.php]]: |
|||
{{$IP}} |
|||
<source lang="php"> |
|||
$wgUseAjax = true; |
|||
$wgSignupAPIUseAjax = true; |
|||
$wgSignupAPISourceTracking = true; |
|||
$wgUseCombinedLoginLink = false; |
|||
require_once("$IP/extensions/SignupAPI/SignupAPI.php"); |
|||
</source> |
|||
Finally, take a backup of your existing database & run [[Manual:Update.php|update.php]] to create the sourcetracking table. |
|||
===Configuration parameters=== |
|||
$wgUseAjax |
|||
This parameter is required to use AJAX & is set to true by default in MediaWiki 1.17 & above |
|||
$wgSignupAPIUseAjax |
|||
If set to true, the extension will AJAX-ify the signup form & facilitate the validation of username, password, retype & email dynamically before submitting the form |
|||
$wgSignupAPISourceCreation |
|||
If set to true, the extension will add the source tracking paramaters to the 'Create account' link & on successful signup will store them inside the sourcetracking table |
|||
$wgUseCombinedLoginLink |
|||
This parameter is used to display separate links for Login & Create account instead of the combined 'Login/Create account' link. |
|||
==Screenshot== |
|||
[[File:SignupAPI-Extension.png]] |
|||
==See also== |
|||
* [[Requests for comment/Account_creation]] |
|||
* [[Extension:E3Experiments]] improves the signup form "[[account creation user experience]]", also using AJAX validation. |
|||
* {{gerrit|18127}} adds an account creation API to MediaWiki core |
|||