Difference between revisions of "Design Document index Page"
(updated to comply with Release 0.4.x of BOARD18.) |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Design Document Index}} | {{ReleaseNotice|0.4}}{{Design Document Index}} | ||
The index.html page can be used to register a new player or [by a registered player] to Login to BOARD18.<br> | The index.html page can be used to register a new player or [by a registered player] to Login to BOARD18.<br> | ||
It also can be used [by a registered player] to recover a lost login ID or a lost password. | It also can be used [by a registered player] to recover a lost login ID or a lost password. | ||
| Line 8: | Line 8: | ||
The index.html page also uses the scripts/board18com.js file and some other open source JavaScript files.<br> | The index.html page also uses the scripts/board18com.js file and some other open source JavaScript files.<br> | ||
Style is supplied by the style/board18Index.css and the style/board18com.css files. | Style is supplied by the style/board18Index.css and the style/board18com.css files. | ||
== Login == | |||
{{WIKI Links for BOARD18 WEB Pages}}Entering a Player ID and a Password on the Login form and pressing the Login button initiates a BOARD18 Login process.<br> | |||
BOARD18 does some preliminary validation on the user input and then passes the validated input to php/validateUser.php.<br> | |||
The php/validateUser.php program, which is called via AJAX ($.post), is documented on the [[Design_Document_Server_Side_Coding_Details#validateUser.php|validateUser.php]] WIKI page. | |||
== Registration == | == Registration == | ||
Clicking the "Register" button on the Log In form causes the Registration form to be displayed.<br> | |||
This form does some preliminary validation on the user input and then passes the validated input to php/newUser.php.<br> | This form does some preliminary validation on the user input and then passes the validated input to php/newUser.php.<br> | ||
The php/newUser.php program, which is called via AJAX | The php/newUser.php program, which is called via AJAX ($.post), is documented on the [[Design_Document_Server_Side_Coding_Details#newUser.php|newUser.php]] WIKI page. | ||
== Login ID Recovery == | == Login ID Recovery == | ||
Clicking the "Forgot your Player ID?" button on the Log In form will bring up a login recovery form.<br> | Clicking the "Forgot your Player ID?" button on the Log In form will bring up a login recovery form.<br> | ||
The player can use this form to get the php/emailPlayerID.php program to send an email containing his Player ID.<br> | The player can use this form to get the php/emailPlayerID.php program to send an email containing his Player ID.<br> | ||
The php/emailPlayerID.php program, which is called via AJAX | The php/emailPlayerID.php program, which is called via AJAX ($.post), is documented on the [[Design_Document_Server_Side_Coding_Details#emailPlayerID.php|emailPlayerID.php]] WIKI page. | ||
== Password Recovery == | == Password Recovery == | ||
Clicking the "Forgot your Password?" button on the Log In form will bring up a password recovery form.<br> | Clicking the "Forgot your Password?" button on the Log In form will bring up a password recovery form.<br> | ||
The player can use this form to get the php/emailPassword.php program to send an email containing a new temporary password.<br> | The player can use this form to get the php/emailPassword.php program to send an email containing a new temporary password.<br> | ||
The php/emailPassword.php program, which is called via AJAX | The php/emailPassword.php program, which is called via AJAX ($.post), is documented on the [[Design_Document_Server_Side_Coding_Details#emailPassword.php|emailPassword.php]] WIKI page. | ||
[[Category:Design]] | [[Category:Design]] | ||
Revision as of 14:19, 9 October 2014
| This page has been updated to comply with Release 0.4.x of BOARD18. |
| Design Document edit | |
The index.html page can be used to register a new player or [by a registered player] to Login to BOARD18.
It also can be used [by a registered player] to recover a lost login ID or a lost password.
Most of the JavaScript logic for index.html is in the scripts/board18index.js file.
The index.html page also uses the scripts/board18com.js file and some other open source JavaScript files.
Style is supplied by the style/board18Index.css and the style/board18com.css files.
Login
Entering a Player ID and a Password on the Login form and pressing the Login button initiates a BOARD18 Login process.
BOARD18 does some preliminary validation on the user input and then passes the validated input to php/validateUser.php.
The php/validateUser.php program, which is called via AJAX ($.post), is documented on the validateUser.php WIKI page.
Registration
Clicking the "Register" button on the Log In form causes the Registration form to be displayed.
This form does some preliminary validation on the user input and then passes the validated input to php/newUser.php.
The php/newUser.php program, which is called via AJAX ($.post), is documented on the newUser.php WIKI page.
Login ID Recovery
Clicking the "Forgot your Player ID?" button on the Log In form will bring up a login recovery form.
The player can use this form to get the php/emailPlayerID.php program to send an email containing his Player ID.
The php/emailPlayerID.php program, which is called via AJAX ($.post), is documented on the emailPlayerID.php WIKI page.
Password Recovery
Clicking the "Forgot your Password?" button on the Log In form will bring up a password recovery form.
The player can use this form to get the php/emailPassword.php program to send an email containing a new temporary password.
The php/emailPassword.php program, which is called via AJAX ($.post), is documented on the emailPassword.php WIKI page.