Design Document board18View Page

From BOARD18 Project WIKI
Revision as of 18:45, 22 July 2020 by Rich (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
This page has been updated to comply with Release 2.5.x of BOARD18.
Design Document edit

This page can be used to select an existing game to view.

Most of the JavaScript logic for board18View is in the scripts/board18View.js file.

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

The Filter Box

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

The filter box (see below) has a Box Name field which can be used to limit the table to the games that use a specific Game Box. When specifying a Game Box do not include the version and use exact capitalization. The filter box also contains a Status selector which can be used to limit the table to only Active or Completed games. To re-display the table after changing the filters, please press the Submit button.

The Gamelist Table

When entered, board18View.php uses an AJAX call to php/allGameList.php to get a table containing a subset of all the games that currently exist in the database. The table contains 5 columns: Game Name, Box Name, Version, Status and Start Date. The table is sorted in reverse order of creation date. That is, the most recently created games appear first.

The php/allGameList.php program is documented on the allGameList.php WIKI page.

The returned list is displayed in the gamelist table as shown below.

Clicking on the name of a listed game will start a game session for that game.


Select a Game to View

Clicking on an entry in the "Game Name" column will link to the Game Board page for that game.
Note that if you are not a player in the selected game then you will not be allowed to save updates.

Transfering to the Main Page

Selecting "Main Page" from the main menu will link to the board18Main page.

Perform Administrative Actions for the Logged-in Player

Selecting "Administration" from the main menu will link to the board18Admin page.
This page will allow the editing of the player's profile.

Starting A New Game Session

Selecting "Make New Game" from the main menu will link to the board18New page.
This page contains a form for starting a new game session.