Web Interface - Revision history

Frank@tygron.nl: /* Limitations */

2023-11-15T12:54:03Z

Limitations

← Older revision		Revision as of 12:54, 15 November 2023
Line 11:		Line 11:

	===Limitations===		===Limitations===
	The web interface does not function as a perfect replacement for the regular, [[3D Visualization]] and [[viewer ]]interface. Contrary to the regular interface, the [[project] is displayed in 2D. It's not possible to draw selections in the 2D map, which means that users will be unable to take conventional [[action]]s such as placing [[building]]s or [[land transactions\|purchasing land]]. Visuals, such as [[cinematic]]s, [[Special Effects\|special effect]]s, [[weather\|weather effects]], and [[units\|visible traffic]] are not yet available for the 2D map. The web interface also remains available while a (multi-user) [[session]] is [[pause]]d.		The web interface does not function as a perfect replacement for the regular, [[3D Visualization]] and [[viewer ]]interface. Contrary to the regular interface, the [[project]] is displayed in 2D. It's not possible to draw selections in the 2D map, which means that users will be unable to take conventional [[action]]s such as placing [[building]]s or [[land transactions\|purchasing land]]. Visuals, such as [[cinematic]]s, [[Special Effects\|special effect]]s, [[weather\|weather effects]], and [[units\|visible traffic]] are not yet available for the 2D map. The web interface also remains available while a (multi-user) [[session]] is [[pause]]d.

	==Accessing the Web Interface==		==Accessing the Web Interface==

Frank@tygron.nl: /* Session tokens */

2023-03-02T10:23:02Z

Session tokens

← Older revision		Revision as of 10:23, 2 March 2023
Line 109:		Line 109:
	Each [[session]] has a unique session token, 8 characters long. This token uniquely identifies a session. Each time a [[project]] is started in the [[editor]], that editing session will have a new session token. When a project is loaded as a [[single user\|single]] or [[multi user]] session, those sessions also each have a unique session token. When there are multiple teams, each team is a separate session and as such each have their own unique token.		Each [[session]] has a unique session token, 8 characters long. This token uniquely identifies a session. Each time a [[project]] is started in the [[editor]], that editing session will have a new session token. When a project is loaded as a [[single user\|single]] or [[multi user]] session, those sessions also each have a unique session token. When there are multiple teams, each team is a separate session and as such each have their own unique token.

	When a [[~~single user~~\|single]] or [[multi user]] ~~session~~ is [[save]]d, its session token is saved as well. When (re)loading that saved state, the session will have the same session token.		When a [[session\|single or multi user session]] is [[save]]d, its session token is saved as well. When (re)loading that saved state, the session will have the same session token.

	''Note: When there is already a session running with the same session token, the newly loaded session will have a new, random session token. This may occur when a save state is loaded multiple times in the same moment.''		''Note: When there is already a session running with the same session token, the newly loaded session will have a new, random session token. This may occur when a save state is loaded multiple times in the same moment.''

Frank@tygron.nl: /* Validity of authentication tokens */

2023-03-02T10:22:35Z

Validity of authentication tokens

← Older revision		Revision as of 10:22, 2 March 2023
Line 29:		Line 29:
	Links in the {{software}} for the web interface are automatically supplied with a valid token. The token will differ between stakeholders. This means that 2 users, who are to control different stakeholders, can be provided with the same link but with a different token.		Links in the {{software}} for the web interface are automatically supplied with a valid token. The token will differ between stakeholders. This means that 2 users, who are to control different stakeholders, can be provided with the same link but with a different token.

	When a [[~~single user~~\|single]] or [[multi user]] ~~session~~ is [[save]]d and closed, and later reloaded, the exact same tokens will be valid, and be related to the exact same stakeholders, except when there is already a session active with the same tokens.		When a [[session\|single or multi user session]] is [[save]]d and closed, and later reloaded, the exact same tokens will be valid, and be related to the exact same stakeholders, except when there is already a session active with the same tokens.

	See also: {{inlink\|Authentication}}.		See also: {{inlink\|Authentication}}.

Frank@tygron.nl at 10:21, 2 March 2023

2023-03-02T10:21:58Z

← Older revision		Revision as of 10:21, 2 March 2023
Line 11:		Line 11:

	===Limitations===		===Limitations===
	The web interface does not function as a perfect replacement for the regular, [[3D Visualization]] and [[viewer ]]interface. Contrary to the regular interface, the [[project] is displayed in 2D. It's not possible to draw selections in the 2D map, which means that users will be unable to take conventional [[action]]s such as placing [[building]]s or [[land ~~transaction~~\|purchasing land]]. Visuals, such as [[cinematic]]s, [[Special Effects\|special effect]]s, [[weather\|weather effects]], and [[units\|visible traffic]] are not yet available for the 2D map. The web interface also remains available while a (multi-user) [[session]] is [[pause]]d.		The web interface does not function as a perfect replacement for the regular, [[3D Visualization]] and [[viewer ]]interface. Contrary to the regular interface, the [[project] is displayed in 2D. It's not possible to draw selections in the 2D map, which means that users will be unable to take conventional [[action]]s such as placing [[building]]s or [[land transactions\|purchasing land]]. Visuals, such as [[cinematic]]s, [[Special Effects\|special effect]]s, [[weather\|weather effects]], and [[units\|visible traffic]] are not yet available for the 2D map. The web interface also remains available while a (multi-user) [[session]] is [[pause]]d.

	==Accessing the Web Interface==		==Accessing the Web Interface==

Frank@tygron.nl at 13:39, 1 March 2023

2023-03-01T13:39:51Z

← Older revision		Revision as of 13:39, 1 March 2023
Line 107:		Line 107:

	===Session tokens===		===Session tokens===
	Each [[session]] has a unique session token, 8 characters long. This token uniquely identifies a session. Each time a [[project]] is started in the [[editor]], that editing session will have a new session token. When a project is loaded as a [[single user\|single]] or [[multi user]] session, those sessions also each have a unique session token. When there are multiple teams, each team is a separate session ~~(even when managed by a single [[facilitator]] application),~~ and as such each have their own unique token.		Each [[session]] has a unique session token, 8 characters long. This token uniquely identifies a session. Each time a [[project]] is started in the [[editor]], that editing session will have a new session token. When a project is loaded as a [[single user\|single]] or [[multi user]] session, those sessions also each have a unique session token. When there are multiple teams, each team is a separate session and as such each have their own unique token.

	When a [[single user\|single]] or [[multi user]] session is [[save]]d, its session token is saved as well. When (re)loading that saved state, the session will have the same session token.		When a [[single user\|single]] or [[multi user]] session is [[save]]d, its session token is saved as well. When (re)loading that saved state, the session will have the same session token.

Frank@tygron.nl at 15:04, 20 February 2023

2023-02-20T15:04:25Z

← Older revision		Revision as of 15:04, 20 February 2023
Line 43:		Line 43:
	The map of the web interface is the most important part of the web interface. The map is only displayed in 2D, rather than [[3D Visualization]] in the regular [[client]]. It is possible to move around across the map by clicking and dragging. It's also possible to zoom in and out by using the scroll wheel.		The map of the web interface is the most important part of the web interface. The map is only displayed in 2D, rather than [[3D Visualization]] in the regular [[client]]. It is possible to move around across the map by clicking and dragging. It's also possible to zoom in and out by using the scroll wheel.

	By default, the map will display the satellite map, which is also seen in the 3D interface. Overlaid on top are the polygons indicating the locations of [[terrain\|water]], roads, and [[building]]s such as buildings.		By default, the map will display the satellite map, which is also seen in the [[Viewer ]]interface. Overlaid on top are the polygons indicating the locations of [[terrain\|water]], roads, and [[building]]s such as buildings.

	{{Editor steps\|title=change the base map\|Open the Web Settings panel.\|Change the "Base map" to the desired setting.}}<br clear=right>		{{Editor steps\|title=change the base map\|Open the Web Settings panel.\|Change the "Base map" to the desired setting.}}<br clear=right>

Frank@tygron.nl at 14:40, 20 February 2023

2023-02-20T14:40:09Z

← Older revision		Revision as of 14:40, 20 February 2023
Line 2:		Line 2:

	==Web interface for {{software}} projects==		==Web interface for {{software}} projects==
	Besides the regular [[~~user interface~~]] provided by the {{software}}, there is also web interface available for the participants in a [[session]]. This interface can be accessed using most modern web browsers. It is completely composed of HTML, CSS, and javascript, functioning like a common web page. The CSS file can be changed, and HTML and javascript can be injected into the interface, as part of a [[panel]] which can be selected via the [[editor]]. This allows the web interface to be fully customized in both function and appearance.		Besides the regular [[viewer ]]interface provided by the {{software\|client}}, there is also web interface available for the participants in a [[session]]. This interface can be accessed using most modern web browsers. It is completely composed of HTML, CSS, and javascript, functioning like a common web page. The CSS file can be changed, and HTML and javascript can be injected into the interface, as part of a [[panel]] which can be selected via the [[editor]]. This allows the web interface to be fully customized in both function and appearance.

	The web interface can be found at the url {{url\|link=1\|protocol=1\|append=/web/}}. A correct {{inlink\|Authentication\|authentication token}} must be provided as a parameter. The resulting url will be of the form:		The web interface can be found at the url {{url\|link=1\|protocol=1\|append=/web/}}. A correct {{inlink\|Authentication\|authentication token}} must be provided as a parameter. The resulting url will be of the form:
Line 11:		Line 11:

	===Limitations===		===Limitations===
	The web interface does not function as a perfect replacement for the regular, [[3D Visualization]] and [[~~user interface~~]]. Contrary to the regular ~~user~~ interface, the [[project] is displayed in 2D. It's not possible to draw selections in the 2D map, which means that users will be unable to take conventional [[action]]s such as placing [[building]]s or [[land transaction\|purchasing land]]. Visuals, such as [[cinematic]]s, [[Special Effects\|special effect]]s, [[weather\|weather effects]], and [[units\|visible traffic]] are not yet available for the 2D map. The web interface also remains available while a (multi-user) [[session]] is [[pause]]d.		The web interface does not function as a perfect replacement for the regular, [[3D Visualization]] and [[viewer ]]interface. Contrary to the regular interface, the [[project] is displayed in 2D. It's not possible to draw selections in the 2D map, which means that users will be unable to take conventional [[action]]s such as placing [[building]]s or [[land transaction\|purchasing land]]. Visuals, such as [[cinematic]]s, [[Special Effects\|special effect]]s, [[weather\|weather effects]], and [[units\|visible traffic]] are not yet available for the 2D map. The web interface also remains available while a (multi-user) [[session]] is [[pause]]d.

	==Accessing the Web Interface==		==Accessing the Web Interface==
Line 48:		Line 48:

	===Session Interface===		===Session Interface===
	The session interface is, in principle, the same as the regular [[~~user interface~~]]. The [[top bar]] can be found at the top of the screen, and the [[map panel]] on the right of the screen. However, there is no action menu available.		The session interface is, in principle, the same as the regular [[viewer ]]interface. The [[top bar]] can be found at the top of the screen, and the [[map panel]] on the right of the screen. However, there is no action menu available.

	When a [[popup]] appears in the [[3D Visualization]], for example because of a [[stakeholder]] taking an [[action]], or a [[panel]] being/becoming visible, the popup will be visible in the 2D map as well, and can be interacted with. Clicking the popup will open the related popup with the same contents and options are would be available in the ~~3D interface~~. [[Attention (Panel Attribute)\|Attention]] is not explicitly drawn to any popups in the web interface.		When a [[popup]] appears in the [[3D Visualization]], for example because of a [[stakeholder]] taking an [[action]], or a [[panel]] being/becoming visible, the popup will be visible in the 2D map as well, and can be interacted with. Clicking the popup will open the related popup with the same contents and options are would be available in the {{software\|client}}. [[Attention (Panel Attribute)\|Attention]] is not explicitly drawn to any popups in the web interface.

	The session interface can not be edited directly. However, it is possible to use {{inlink\|CSS}}, or {{inlink\|Custom HTML\|javascript in a custom panel}}, to hide, move, or alter any available interface elements.		The session interface can not be edited directly. However, it is possible to use {{inlink\|CSS}}, or {{inlink\|Custom HTML\|javascript in a custom panel}}, to hide, move, or alter any available interface elements.
Line 81:		Line 81:
	Each project has a default CSS file which defines the default styling for the web interface. This CSS file can be downloaded from a project while in the [[editor]]. New or modified CSS files can also be uploaded to the project. In principle, only one CSS file can be uploaded at a time. Only one CSS file is provided in the web interface at a time. When uploading a new CSS file, it overwrites the existing CSS file.		Each project has a default CSS file which defines the default styling for the web interface. This CSS file can be downloaded from a project while in the [[editor]]. New or modified CSS files can also be uploaded to the project. In principle, only one CSS file can be uploaded at a time. Only one CSS file is provided in the web interface at a time. When uploading a new CSS file, it overwrites the existing CSS file.

	It is important to note that the CSS file is only provided to the web interface (both the 2D map and the frontpage), and not to the ~~regular~~ [[~~user interface~~]]. This means that if the CSS file affects the styling of the contents of [[panel]]s or [[indicator]]s, there may be styling differences between the ~~regular~~ [[~~user interface~~]] and the web interface.		It is important to note that the CSS file is only provided to the web interface (both the 2D map and the frontpage), and not to the [[viewer ]]interface. This means that if the CSS file affects the styling of the contents of [[panel]]s or [[indicator]]s, there may be styling differences between the [[viewer ]]interface and the web interface.

	{{Editor steps\|title=retrieving the current CSS file\|Open the Web Settings panel.\|Select "Download current CSS file".}}		{{Editor steps\|title=retrieving the current CSS file\|Open the Web Settings panel.\|Select "Download current CSS file".}}
Line 136:		Line 136:

	===Requesting information===		===Requesting information===
	Not all information from a project is available to the web interface. Notably available information are panels, popups, overlays, indicators, and buildings. However, information that is only available to specific stakeholders in the ~~regular user~~ interface is also only available to stakeholders in the web interface. For example: a web request for an indicator which exists in the project but which is not currently linked to the stakeholder will trigger an error message. The same goes for panels which exist but are linked to a specific stakeholder which is not the requesting stakeholder. If a panel is not linked to a specific stakeholder, the panel is available to any stakeholder.		Not all information from a project is available to the web interface. Notably available information are panels, popups, overlays, indicators, and buildings. However, information that is only available to specific stakeholders in the [[viewer ]]interface is also only available to stakeholders in the web interface. For example: a web request for an indicator which exists in the project but which is not currently linked to the stakeholder will trigger an error message. The same goes for panels which exist but are linked to a specific stakeholder which is not the requesting stakeholder. If a panel is not linked to a specific stakeholder, the panel is available to any stakeholder.

	There are no explicit settings for the web interface available concerning requesting information. It is a consideration which should be taken into account when creating the content of panels and indicators.		There are no explicit settings for the web interface available concerning requesting information. It is a consideration which should be taken into account when creating the content of panels and indicators.

Frank@tygron.nl: /* Firing events */

2023-01-30T12:45:52Z

Firing events

← Older revision		Revision as of 12:45, 30 January 2023
Line 146:		Line 146:

	{{editor tools nav}}		{{editor tools nav}}
			[[Category:Interface]]

Frank@tygron.nl: /* Session Interface */

2023-01-27T16:36:29Z

Session Interface

← Older revision		Revision as of 16:36, 27 January 2023
Line 50:		Line 50:
	The session interface is, in principle, the same as the regular [[user interface]]. The [[top bar]] can be found at the top of the screen, and the [[map panel]] on the right of the screen. However, there is no action menu available.		The session interface is, in principle, the same as the regular [[user interface]]. The [[top bar]] can be found at the top of the screen, and the [[map panel]] on the right of the screen. However, there is no action menu available.

	When a [[popup]] appears in the [[3D ~~visualization~~]], for example because of a [[stakeholder]] taking an [[action]], or a [[panel]] being/becoming visible, the popup will be visible in the 2D map as well, and can be interacted with. Clicking the popup will open the related popup with the same contents and options are would be available in the 3D interface. [[Attention (Panel Attribute)\|Attention]] is not explicitly drawn to any popups in the web interface.		When a [[popup]] appears in the [[3D Visualization]], for example because of a [[stakeholder]] taking an [[action]], or a [[panel]] being/becoming visible, the popup will be visible in the 2D map as well, and can be interacted with. Clicking the popup will open the related popup with the same contents and options are would be available in the 3D interface. [[Attention (Panel Attribute)\|Attention]] is not explicitly drawn to any popups in the web interface.

	The session interface can not be edited directly. However, it is possible to use {{inlink\|CSS}}, or {{inlink\|Custom HTML\|javascript in a custom panel}}, to hide, move, or alter any available interface elements.		The session interface can not be edited directly. However, it is possible to use {{inlink\|CSS}}, or {{inlink\|Custom HTML\|javascript in a custom panel}}, to hide, move, or alter any available interface elements.

Frank@tygron.nl at 16:36, 27 January 2023

2023-01-27T16:36:08Z

← Older revision		Revision as of 16:36, 27 January 2023
Line 40:		Line 40:

	===Map===		===Map===
	[[File:web-settings-map.jpg\|frame\|right\|The ~~dropdown~~ option to change the base map type.]]		[[File:web-settings-map.jpg\|frame\|right\|The drop-down option to change the base map type.]]
	The map of the web interface is the most important part of the web interface. The map is only displayed in 2D, rather than 3D in the regular [[client]]~~. Despite this, it can still be referred to as the [[3D World]] for most purposes~~. It is possible to move around across the map by clicking and dragging. It's also ~~posible~~ to zoom in and out by using the ~~scrollwheel~~.		The map of the web interface is the most important part of the web interface. The map is only displayed in 2D, rather than [[3D Visualization]] in the regular [[client]]. It is possible to move around across the map by clicking and dragging. It's also possible to zoom in and out by using the scroll wheel.

	By default, the map will display the satellite map, which is also seen in the 3D interface. Overlaid on top are the polygons indicating the locations of [[terrain\|water]], roads, and [[building]]s such as buildings.		By default, the map will display the satellite map, which is also seen in the 3D interface. Overlaid on top are the polygons indicating the locations of [[terrain\|water]], roads, and [[building]]s such as buildings.
Line 50:		Line 50:
	The session interface is, in principle, the same as the regular [[user interface]]. The [[top bar]] can be found at the top of the screen, and the [[map panel]] on the right of the screen. However, there is no action menu available.		The session interface is, in principle, the same as the regular [[user interface]]. The [[top bar]] can be found at the top of the screen, and the [[map panel]] on the right of the screen. However, there is no action menu available.

	When a [[popup]] appears in the ~~world~~, for example because of a [[stakeholder]] taking an [[action]], or a [[panel]] being/becoming visible, the popup will be visible in the 2D map as well, and can be interacted with. Clicking the popup will open the related popup with the same contents and options are would be available in the 3D interface. [[Attention (Panel Attribute)\|Attention]] is not explicitly drawn to any popups in the web interface.		When a [[popup]] appears in the [[3D visualization]], for example because of a [[stakeholder]] taking an [[action]], or a [[panel]] being/becoming visible, the popup will be visible in the 2D map as well, and can be interacted with. Clicking the popup will open the related popup with the same contents and options are would be available in the 3D interface. [[Attention (Panel Attribute)\|Attention]] is not explicitly drawn to any popups in the web interface.

	The session interface can not be edited directly. However, it is possible to use {{inlink\|CSS}}, or {{inlink\|Custom HTML\|javascript in a custom panel}}, to hide, move, or alter any available interface elements.		The session interface can not be edited directly. However, it is possible to use {{inlink\|CSS}}, or {{inlink\|Custom HTML\|javascript in a custom panel}}, to hide, move, or alter any available interface elements.