Difference between revisions of "Design Document board18New Page"

Latest revision as of 08:53, 28 August 2020

This page has been updated to comply with Release 2.6.x of BOARD18.

Design Document ^edit
Introduction Environment Esthetics Game Boxes Objects Data Base Utilities Data Structures	Client Side Overview PHP Overview Client Side Coding PHP AJAX Part 1 PHP AJAX Part 2 PHP AJAX Part 3 PHP Includes

WIKI Links for BOARD18 WEB Pages ^edit
Page Overview	Detail Design
index Page	index Page
board18Main Page	board18Main Page
board18View Page	board18View Page
board18Admin Page	board18Admin Page
board18Players Page	board18Players Page
board18Games Page	board18Games Page
board18Boxes Page	board18Boxes Page
board18BoxLoad Page	board18BoxLoad Page
board18Misc Page	board18Misc Page
board18New Page	board18New Page
board18Map Page	board18Map Page
board18Market Page	board18Market Page
board18SnapList Page	board18SnapList Page
board18SnapMap Page	board18SnapMap Page
board18SnapMrk Page	board18SnapMrk Page
access-denied Page	access-denied Page

Selecting "Make New Game" from the main menu in the board18Main.php page causes the board18New.php page to be displayed.
This page can be used to create a new BOARD18 game.

Most of the JavaScript logic for board18New is in the scripts/board18New1.js and the scripts/board18New2.js files.

The board18New.php page also uses the scripts/board18com.js file and some other open source JavaScript files.
Style is supplied by the style/board18New.css and the style/board18com.css files.

Start a New Game Session

To start a new game session, one must fill in the fields in the New Game Form that is displayed at the top of the "RightOfPage" division.
Clicking on a game box in the Available Game Box Table will enter that game box ID into the game box field on this form.
The active player is automatically entered into the first player field on this form.
Clicking on a player in the Players Table will enter that player ID in the next player field on this form.
When the form is submitted, the fields are verified and then an AJAX call is made to the php/createGame.php program.

Game Box List

When entered board18New.php performs an AJAX call to the boxGetAll.php function to get and display a list of the game boxes that are available for play. This list is directly below the New Game Form. The player must choose a game box from this list. Clicking on a row on this list will copy the Box ID for that game into the form.

List Display Selection Controls

The list display selection controls in each of the list forms can be used to switch between lists and also to filter the box list via the Box Name
Any portion of a box name can be entered in the Filter Game Box Name By field.

Player Lists

board18New can perform an AJAX call to the playerSort.php to display one of three Player Lists. The lists can be sorted by the three displayed fields.
These lists show all of the players known to the server. Clicking on a Player ID will add that player to the form.

@@ Line 1: / Line 1: @@
-{{Design Document Index}}
+__NOTOC__
+{{ReleaseNotice|2.6}}{{Design Document Index}}
+{{WIKI Links for BOARD18 WEB Pages}}
 Selecting "Make New Game" from the main menu in the board18Main.php page
-causes the board18New.php page to be displayed.<br>
+causes the board18New.php page to be displayed. <br>This page can be used to create a new BOARD18 game.
-This page can be used to create a new BOARD18 game.<br>
-Most of the JavaScript logic for these functions is in the scripts/board18New.js file.<br>
+'''Most of the JavaScript logic for board18New is in the [[Board18New1|scripts/board18New1.js]] and the  [[Board18New2|scripts/board18New2.js]] files.'''
 The board18New.php page also uses the scripts/board18com.js file and some other open source JavaScript files.<br>
 Style is supplied by the style/board18New.css and the style/board18com.css files.
-{{WIKI Links for BOARD18 WEB Pages}}== The Available Game Box Table ==
+== Start a New Game Session ==
-When entered board18New.php uses the php showBoxes function to get and display a list of the game boxes that are available for play. <br>
+To start a new game session, one must fill in the fields in the '''New Game Form''' that is displayed at the top of the "RightOfPage" division.<br>
-This list is displayed at the bottom of the "RightOfPage" division.
+Clicking on a game box in the Available Game Box Table will enter that game box ID into the game box field on this form.<br>
+The active player is automatically entered into the first player field on this form.<br>
+Clicking on a player in the Players Table will enter that player ID in the next player field on this form.<br>
+When the form is submitted, the fields are verified and then an AJAX call is made to the php/createGame.php program.
-== The Players Table ==
+== Game Box List ==
-When entered board18New.php uses the php showPlayers function to get and display a list of the players that have userID's on this BOARD18 server.<br>
+When entered board18New.php performs an AJAX call to the boxGetAll.php function to get and display a list of the game boxes that are available for play.
-This list is displayed in the "LeftOfPage" division.
+This list is directly below the '''New Game Form'''. The player must choose a game box from this list.
+Clicking on a row on this list will copy the Box ID for that game into the form.
-== Start a New Game Session ==
+== List Display Selection Controls ==
-To start a new game session, one must fill in the fields in the new game form that is displayed at the top of the "RightOfPage" division.<br>
+The <span style="color: Fuchsia">list display selection controls </span> in each of the list forms can be used
-'''There are currently no shortcuts to automate this chore.'''<br>
+to switch between lists and also to filter the box list via the '''Box Name'''<br>
-When the form is submitted, the fields are verified and then
+Any portion of a box name can be entered in the '''Filter Game Box Name By''' field.
-an AJAX call is made to the php/createGame.php program.<br>
-The php/createGame.php program is documented on the [[Design Document createGame|createGame.php]] WIKI page.<br>
+== Player Lists ==
+board18New can perform an AJAX call to the playerSort.php
+to display one of three Player Lists. The lists can be sorted by the three displayed fields.<br>
+These lists show all of the players known to the server.
+<span style="color: Fuchsia">
+Clicking on a Player ID will add that player to the form.</span>
 [[Category:Design]]