Design Document Client Side Overview - Revision history

Rich: /* The Misc Page */

2020-08-27T17:15:03Z

The Misc Page

← Older revision		Revision as of 17:15, 27 August 2020
Line 47:		Line 47:
	== The Misc Page ==		== The Misc Page ==

	The board18Misc.php page can be used to perform miscellaneous service actions on an in progress game session.		The board18Misc.php page can be used to perform miscellaneous service actions on an in progress game session. It displays a list of the active players in the game and a list of all of the available players as aids to filling out the form.

	== The New Game Page==		== The New Game Page==

Rich: /* Keyboard Shortcuts */

2017-08-15T22:32:14Z

Keyboard Shortcuts

← Older revision		Revision as of 22:32, 15 August 2017
Line 145:		Line 145:

	=== Keyboard Shortcuts ===		=== Keyboard Shortcuts ===
	The Market page supports a number of keyboard shortcuts. A list of these shortcuts can be found [[Player'~~s_Guide_V0~~.~~3#Keyboard_Shortcuts~~\|here]].<br>		The Market page supports a number of keyboard shortcuts. A list of these shortcuts can be found [[Player's_Guide_V2.0_Keyboard_Shortcuts\|here]].<br>
	The logic to handle keyboard shortcuts is contained in the [[Board18Market7\|board18Market7.js]] file.		The logic to handle keyboard shortcuts is contained in the [[Board18Market7\|board18Market7.js]] file.

Rich: added cookie reference to The Index Page

2017-08-11T15:26:37Z

added cookie reference to The Index Page

← Older revision		Revision as of 15:26, 11 August 2017
Line 1:		Line 1:
	{{ReleaseNotice\|2.4}}{{Design Document Index}}The client side application is divided into sections by page. In other words, the server can send a number of different pages to the client browser. Each such page will have its own associated JavaScript file(s) and its own associated CSS file. Pages that include PHP code will have the extension 'php'. Other pages will have the extension 'html'.		{{ReleaseNotice\|2.5}}{{Design Document Index}}The client side application is divided into sections by page. In other words, the server can send a number of different pages to the client browser. Each such page will have its own associated JavaScript file(s) and its own associated CSS file. Pages that include PHP code will have the extension 'php'. Other pages will have the extension 'html'.

	Currently I have implemented sixteen pages, but more may be be added as needed.		Currently I have implemented sixteen pages, but more may be be added as needed.


	== The Index Page==		== The Index Page ==

	The index.html page is one of the two pages which is not password protected. It is the introductory page to BOARD18 and contains a welcome message. It is used for logging in to Board18 and for registering new players. It also contains player ID and password recovery functions.		The index.html page is one of the two pages which is not password protected. It is the introductory page to BOARD18 and contains a welcome message. It is used for logging in to Board18 and for registering new players. It also contains player ID and password recovery functions. The index.html and access-denied.html page make use of a number of cookies to control the sign-in and security experience of BOARD18. These cookies are described [[Player's Guide V2.5 Cookies\|on this page]].

	== The Access-denied Page==		== The Access-denied Page ==

	The access-denied.html page is the other of the two pages which is not password protected. It is the page that handles unauthorized access to password protected pages. It has an access denied message but is otherwise identical to the index.html page.		The access-denied.html page is the other of the two pages which is not password protected. It is the page that handles unauthorized access to password protected pages. It has an access denied message but is otherwise identical to the index.html page.

Rich at 03:18, 29 December 2016

2016-12-29T03:18:06Z

← Older revision		Revision as of 03:18, 29 December 2016
Line 1:		Line 1:
	{{ReleaseNotice\|2.1}}{{Design Document Index}}The client side application is divided into sections by page. In other words, the server can send a number of different pages to the client browser. Each such page will have its own associated JavaScript file(s) and its own associated CSS file. Pages that include PHP code will have the extension 'php'. Other pages will have the extension 'html'.		{{ReleaseNotice\|2.4}}{{Design Document Index}}The client side application is divided into sections by page. In other words, the server can send a number of different pages to the client browser. Each such page will have its own associated JavaScript file(s) and its own associated CSS file. Pages that include PHP code will have the extension 'php'. Other pages will have the extension 'html'.

	Currently I have implemented sixteen pages, but more may be be added as needed.		Currently I have implemented sixteen pages, but more may be be added as needed.

Rich: /* The Admin Page */ added reference to new link

2016-12-29T03:17:33Z

The Admin Page: added reference to new link

← Older revision		Revision as of 03:17, 29 December 2016
Line 26:		Line 26:
	The board18Admin.php page contains a form that can be used to change the player's first name, last name, email address or password.		The board18Admin.php page contains a form that can be used to change the player's first name, last name, email address or password.
	It also has a special form to handle forced password changes. The left side of the board18Admin.php page is normally blank but		It also has a special form to handle forced password changes. The left side of the board18Admin.php page is normally blank but
	for an admin level player it contains links to 3 other pages which can only be accessed by admin level players.		for an admin level player it contains links to 3 other pages which can only be accessed by admin level players. And one other page that
			can only be accessed by admin or author level players.

	== The Players Page ==		== The Players Page ==

Rich: /* Right Click Context Sensitive Menus */ added link

2016-07-03T13:01:24Z

Right Click Context Sensitive Menus: added link

← Older revision		Revision as of 13:01, 3 July 2016
Line 139:		Line 139:
	=== Right Click Context Sensitive Menus ===		=== Right Click Context Sensitive Menus ===
	A right or left click event on the stock chart in the Market page can cause a context menu to be displayed. Whether this menu is displayed at all '''and''' the selection of items in this menu are '''both''' dependent on the context of the event. All of the "context menu logic" that performs this function is contained in the [[Board18Market5\|board18Market5.js]] file. Special logic to handle boxes that contain multiple tokens is contained in the [[Board18Market4\|board18Market4.js]] file. See the		A right or left click event on the stock chart in the Market page can cause a context menu to be displayed. Whether this menu is displayed at all '''and''' the selection of items in this menu are '''both''' dependent on the context of the event. All of the "context menu logic" that performs this function is contained in the [[Board18Market5\|board18Market5.js]] file. Special logic to handle boxes that contain multiple tokens is contained in the [[Board18Market4\|board18Market4.js]] file. See the
	Right Click Context Sensitive Menus section in the Map Page section of this document		[[Design_Document_Client_Side_Overview#Right_Click_Context_Sensitive_Menus\|
			Right Click Context Sensitive Menus section in the Map Page section of this document]]
	for more information on positioning these menus.		for more information on positioning these menus.

Rich: /* The Right Click Context Menu */ revised based on new implementation.

2016-07-03T12:59:15Z

The Right Click Context Menu: revised based on new implementation.

← Older revision		Revision as of 12:59, 3 July 2016
Line 137:		Line 137:
	A move in progress will be submitted to the server database when the '''Accept Move''' menu item is clicked. A move in progress will be discarded when the '''Cancel Move''' menu item is clicked. These options are also provided on the right click context menu and with keyboard shortcuts.		A move in progress will be submitted to the server database when the '''Accept Move''' menu item is clicked. A move in progress will be discarded when the '''Cancel Move''' menu item is clicked. These options are also provided on the right click context menu and with keyboard shortcuts.

	=== ~~The~~ Right Click Context ~~Menu~~===		=== Right Click Context Sensitive Menus ===
	A right click event on the stock chart in the Market page can cause a context menu to be displayed. Whether this menu is displayed at all '''and''' the selection of items in this menu are '''both''' ~~dependant~~ on the context of the event. All of the "context menu logic" that performs this function is contained in the [[Board18Market5\|board18Market5.js]] file. Special logic to handle boxes that contain multiple tokens is contained in the [[Board18Market4\|board18Market4.js]] file.		A right or left click event on the stock chart in the Market page can cause a context menu to be displayed. Whether this menu is displayed at all '''and''' the selection of items in this menu are '''both''' dependent on the context of the event. All of the "context menu logic" that performs this function is contained in the [[Board18Market5\|board18Market5.js]] file. Special logic to handle boxes that contain multiple tokens is contained in the [[Board18Market4\|board18Market4.js]] file. See the
			Right Click Context Sensitive Menus section in the Map Page section of this document
			for more information on positioning these menus.

	=== Keyboard Shortcuts ===		=== Keyboard Shortcuts ===

Rich: /* The Right Click Context Menu */ revised based on new implementation.

2016-07-03T12:54:35Z

The Right Click Context Menu: revised based on new implementation.

← Older revision		Revision as of 12:54, 3 July 2016
Line 89:		Line 89:
	A move in progress will be submitted to the server database when the '''Accept Move''' menu item is clicked. A move in progress will be discarded when the '''Cancel Move''' menu item is clicked. These options are also provided on the right click context menu and with keyboard shortcuts .		A move in progress will be submitted to the server database when the '''Accept Move''' menu item is clicked. A move in progress will be discarded when the '''Cancel Move''' menu item is clicked. These options are also provided on the right click context menu and with keyboard shortcuts .

	=== ~~The~~ Right Click Context ~~Menu~~===		=== Right Click Context Sensitive Menus ===
	A right click event on the game board in the Map page can cause a context menu to be displayed. Whether this menu is displayed at all '''and''' the selection of items in this menu are '''both''' ~~dependant~~ on the context of the event. All of the "context menu logic" that performs this function is contained in the [[Board18Map5\|board18Map5.js]] file. Special logic to handle hexes that contain multiple items is contained in the [[Board18Map4\|board18Map4.js]] file.		Both the BOARD18 map page and the BOARD18 market page use
			context sensitive menus and token selection canvases to
			enable players to specify their moves. Positioning for these
			is implemented using the following design principles.

			# All positioning is based on the document. Thus the menu division and the token selection canvas are defined with the body as their immediate parent.
			# A common docPos(event) function is provided which returns the position in the document of a mouse event. This function should work with any current browser.
			# The positioning if a token selection canvas should be based on the position of the mouse event which displays the context menu not the mouse event which selects an item from this menu.
			# Logic is provided to adjust positioning for menu and canvas instances that would otherwise overlap the right or bottom edges of the document.

			A right or left click event on the game board in the Map page can cause a context menu to be displayed. Whether this menu is displayed at all '''and''' the selection of items in this menu are '''both''' dependent on the context of the event. All of the "context sensitive menu logic" that performs this function is contained in the [[Board18Map5\|board18Map5.js]] file. Special logic to handle hexes that contain multiple items is contained in the [[Board18Map4\|board18Map4.js]] file.

	=== Keyboard Shortcuts ===		=== Keyboard Shortcuts ===

Rich: added BoxLoad page

2016-07-03T12:45:55Z

added BoxLoad page

← Older revision		Revision as of 12:45, 3 July 2016
Line 1:		Line 1:
	{{ReleaseNotice\|2.1}}{{Design Document Index}}The client side application is divided into sections by page. In other words, the server can send a number of different pages to the client browser. Each such page will have its own associated JavaScript file(s) and its own associated CSS file. Pages that include PHP code will have the extension 'php'. Other pages will have the extension 'html'.		{{ReleaseNotice\|2.1}}{{Design Document Index}}The client side application is divided into sections by page. In other words, the server can send a number of different pages to the client browser. Each such page will have its own associated JavaScript file(s) and its own associated CSS file. Pages that include PHP code will have the extension 'php'. Other pages will have the extension 'html'.

	Currently I have implemented ~~fifteen~~ pages, but more may be be added as needed.		Currently I have implemented sixteen pages, but more may be be added as needed.


Line 39:		Line 39:

	The board18Boxes.php page is used to administer game boxes. It can only be accessed by admin level players.		The board18Boxes.php page is used to administer game boxes. It can only be accessed by admin level players.

			== The BoxLoad Page ==

			The board18BoxLoad.php page is used to load new game boxes from a browser to BOARD18. It can only be accessed by author or admin level players.

	== The Misc Page ==		== The Misc Page ==

Rich: 2.1

2016-06-03T14:49:42Z

2.1

← Older revision		Revision as of 14:49, 3 June 2016
Line 1:		Line 1:
	The client side application is divided into sections by page. In other words, the server can send a number of different pages to the client browser. Each such page will have its own associated JavaScript file(s) and its own associated CSS file. Pages that include PHP code will have the extension 'php'. Other pages will have the extension 'html'.		{{ReleaseNotice\|2.1}}{{Design Document Index}}The client side application is divided into sections by page. In other words, the server can send a number of different pages to the client browser. Each such page will have its own associated JavaScript file(s) and its own associated CSS file. Pages that include PHP code will have the extension 'php'. Other pages will have the extension 'html'.

			Currently I have implemented fifteen pages, but more may be be added as needed.

	~~Currently I have implemented fifteen pages, but more may be be added as needed. {{Design Document Index}}~~
	~~{{ReleaseNotice\|1.2}}~~

	== The Index Page==		== The Index Page==