Web Interface - Revision history

Maxim@tygron.com at 09:41, 15 July 2026

2026-07-15T09:41:43Z

← Older revision		Revision as of 09:41, 15 July 2026
Line 11:		Line 11:

	===Limitations===		===Limitations===
	The web interface has different functional capabilities than 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 has different functional capabilities than 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 [[Buy 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.

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

Frank@tygron.nl at 13:11, 8 July 2026

2026-07-08T13:11:38Z

Maxim@tygron.com at 16:59, 7 July 2026

2026-07-07T16:59:38Z

← Older revision		Revision as of 16:59, 7 July 2026
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 has different functional capabilities than 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.

	==Accessing the Web Interface==		==Accessing the Web Interface==
Line 41:		Line 41:
	===Map===		===Map===
	[[File:web-settings-map.jpg\|frame\|right\|The drop-down 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 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 is the primary component 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 [[Viewer]] interface. Overlaid on top are the polygons indicating the locations of [[terrain\|water]], roads, and [[building]]s.		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.

Maxim@tygron.com at 12:09, 6 July 2026

2026-07-06T12:09:52Z

Maxim@tygron.com at 12:04, 6 July 2026

2026-07-06T12:04:22Z

← Older revision		Revision as of 12:04, 6 July 2026
Line 2:		Line 2:

	==Web interface for {{software}} projects==		==Web interface for {{software}} projects==
	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.		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:

Frank@tygron.nl at 14:39, 9 June 2026

2026-06-09T14:39:04Z

← Older revision		Revision as of 14:39, 9 June 2026
Line 48:		Line 48:

	===Session Interface===		===Session Interface===
	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.		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 [[navigation 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 {{software client}}. [[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.

Frank@tygron.nl: /* Limitations */

2026-06-09T14:37:32Z

Limitations

← Older revision		Revision as of 14:37, 9 June 2026
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.

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

Frank@tygron.nl at 07:48, 9 June 2026

2026-06-09T07:48:25Z

← Older revision		Revision as of 07:48, 9 June 2026
Line 2:		Line 2:

	==Web interface for {{software}} projects==		==Web interface for {{software}} projects==
	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.		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 50:		Line 50:
	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.		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 {{software\|client}}. [[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.

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

2026-05-13T13:19:39Z

Firing events

← Older revision		Revision as of 13:19, 13 May 2026
Line 146:		Line 146:

	{{article end		{{article end
			\|seealso=*[[Setting]]s
	\|api=*[[Api session items settings]]		\|api=*[[Api session items settings]]
	*[[Api session event editor setting set setting]]		*[[Api session event editor setting set setting]]

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

2026-05-13T13:19:12Z

Firing events

← Older revision		Revision as of 13:19, 13 May 2026
Line 148:		Line 148:
	\|api=*[[Api session items settings]]		\|api=*[[Api session items settings]]
	*[[Api session event editor setting set setting]]		*[[Api session event editor setting set setting]]
			}}

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

← Older revision		Revision as of 13:11, 8 July 2026
Line 1:		Line 1:
	A web interface is a graphical interface for software or hardware~~, which allows a user~~ to ~~read out~~ information, or ~~effect~~ changes~~, which takes the form of a web page or multiple web pages~~. By making this functionality available as a web page, the ease of access is greatly improved, as common internet browsers can be used without the need to install additional drivers or software.		A web interface is a graphical interface for software or hardware that uses one or more web pages to allow users to view information or make changes. By making this functionality available as a web page, the ease of access is greatly improved, as common internet browsers can be used without the need to install additional drivers or software.

	==Web interface for {{software}} projects==		==Web interface for {{software}} projects==
Line 50:		Line 50:
	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 [[navigation 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 [[navigation 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 that would be available in the {{software client}}. [[Attention (Panel Attribute)\|Attention]] is not explicitly drawn to any popups in the web interface.		Popups triggered by stakeholder actions or panel visibility in the [[3D Visualization]] also appear on the 2D map and remain interactive. Clicking the popup will open the related popup with the same contents and options that 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 cannot 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 cannot 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 66:		Line 66:
	===Frontpage===		===Frontpage===
	[[File:web-settings-frontpage.jpg\|frame\|right\|The selector for the panel to use as frontpage for the web interface.]]		[[File:web-settings-frontpage.jpg\|frame\|right\|The selector for the panel to use as frontpage for the web interface.]]
	It is also possible to configure a custom frontpage for the web interface. Any [[panel]] in the project can be selected as the frontpage. When a frontpage is set, users ~~will be presented not with the 2D map, but with~~ the defined frontpage content instead. This allows a project creator to add a splashscreen or login page to the web interface. The frontpage is a separate page from the page with the 2D map. The 2D map will not be present on the frontpage. If a {{inlink\|Custom HTML\|custom panel}} is set, the custom panel will also not be present on the frontpage.		It is also possible to configure a custom frontpage for the web interface. Any [[panel]] in the project can be selected as the frontpage. When a frontpage is set, users see the defined frontpage content instead of the 2D map. This allows a project creator to add a splashscreen or login page to the web interface. The frontpage is a separate page from the page with the 2D map. The 2D map will not be present on the frontpage. If a {{inlink\|Custom HTML\|custom panel}} is set, the custom panel will also not be present on the frontpage.

	{{Editor steps\|title=add a frontpage\|Create a [[panel]] with the desired content.\|Open the Web Settings panel.\|Make sure the "Front Page Panel" checkbox is checked.\|Select the desired panel in the dropdown menu.}}		{{Editor steps\|title=add a frontpage\|Create a [[panel]] with the desired content.\|Open the Web Settings panel.\|Make sure the "Front Page Panel" checkbox is checked.\|Select the desired panel in the dropdown menu.}}
Line 131:		Line 131:

	==Security considerations==		==Security considerations==
	Depending on your use-case, there may be ~~some~~ considerations ~~in the line of security~~. For sessions which are only used in closed sessions with known users or partners, these considerations may not apply. However, when offering access to a session to the general public, some consideration should be given to what information or capabilities should be provided to end-users.		Depending on your use case, there may be several security considerations. For sessions which are only used in closed sessions with known users or partners, these considerations may not apply. However, when offering access to a session to the general public, some consideration should be given to what information or capabilities should be provided to end-users.

	An important consequence of the way the web interface is created (HTML, CSS, and Javascript) is that all code can be inspected by the end-users. This means that users can inspect the used URLs for panels, and the way instructions to the {{software}} are structured, and from there create their own requests for information from the web interface.		An important consequence of the way the web interface is created (HTML, CSS, and Javascript) is that all code can be inspected by the end-users. This means that users can inspect the used URLs for panels, and the way instructions to the {{software}} are structured, and from there create their own requests for information from the web interface.

	===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 [[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.		Not all information from a project is available to the web interface. Available information includes 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.

← Older revision		Revision as of 12:09, 6 July 2026
Line 4:		Line 4:
	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.		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:

	{{url\|link=1\|protocol=1\|append=/web/?token=~~TOKEN~~}}		{{url\|link=1\|protocol=1\|append=/web/?token=WEB_TOKEN}}

	In this ~~url~~, "~~TOKEN~~" is replaced with the proper authentication token.		In this URL, "WEB_TOKEN" is replaced with the proper web authentication token.

	===Limitations===		===Limitations===
Line 18:		Line 18:
	{{Editor location\|Web Interface}}		{{Editor location\|Web Interface}}

	When running a single or multi-user session, the user can retrieve their own link (and token) for the web interface. They can do this by taking the following steps:		When running a single or multi-user session, the user can retrieve their own link (and token) for the web interface. They can do this by taking the following steps

	{{Editor steps\|title=get the web interface ~~url~~ as user\|Select the stakeholder name in the [[Top bar]].\|Select "Open in browser".}}		{{Editor steps\|title=get the web interface URL as user\|Select the stakeholder name in the [[Top bar]].\|Select "Open in browser".}}

	Lastly, the facilitator can also retrieve each (playable) [[stakeholder]]'s ~~url~~ and token. In the facilitator application, the link can be obtained by taking the following steps:		Lastly, the facilitator can also retrieve each (playable) [[stakeholder]]'s URL and token. In the facilitator application, the link can be obtained by taking the following steps:

	{{Editor steps\|title=get the web interface ~~url~~ as facilitator\|Select the desired team of which you would like the ~~url~~.\|Select the "Stakeholder" tab.\|Select the desired stakeholder.\|Select "Show frontpage in browser".}}		{{Editor steps\|title=get the web interface URL as facilitator\|Select the desired team of which you would like the URL.\|Select the "Stakeholder" tab.\|Select the desired stakeholder.\|Select "Show frontpage in browser".}}

	===Validity of authentication tokens===		===Validity of authentication tokens===
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 [[Viewer ]]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.

	{{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>
Line 50:		Line 50:
	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 [[navigation 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 [[navigation 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 {{software client}}. [[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 that 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 cannot 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.

	===Custom HTML===		===Custom HTML===
	[[File:web-settings-custom.jpg\|frame\|right\|The selector for the custom panel to add to the web interface.]]		[[File:web-settings-custom.jpg\|frame\|right\|The selector for the custom panel to add to the web interface.]]
	It is possible to add custom content to the web interface as well. A panel can be selected to inject directly into the web interface, in a separate <code><div></code> element with both class and id set to "custom". If the content is HTML, and it contains <code><script></code> elements with javascript, the content will be injected into the page, and the ~~javascript~~ will be executed in order afterwards.		It is possible to add custom content to the web interface as well. A panel can be selected to inject directly into the web interface, in a separate <code><div></code> element with both class and id set to "custom". If the content is HTML, and it contains <code><script></code> elements with javascript, the content will be injected into the page, and the [[JavaScript]] will be executed in order afterwards.

	{{Editor steps\|title=add a custom panel\|Create a [[panel]] with the desired content.\|Open the Web Settings panel.\|Make sure the "Custom Panel" checkbox is checked.\|Select the desired panel in the dropdown menu.}}		{{Editor steps\|title=add a custom panel\|Create a [[panel]] with the desired content.\|Open the Web Settings panel.\|Make sure the "Custom Panel" checkbox is checked.\|Select the desired panel in the dropdown menu.}}
Line 66:		Line 66:
	===Frontpage===		===Frontpage===
	[[File:web-settings-frontpage.jpg\|frame\|right\|The selector for the panel to use as frontpage for the web interface.]]		[[File:web-settings-frontpage.jpg\|frame\|right\|The selector for the panel to use as frontpage for the web interface.]]
	It is also possible to configure a custom frontpage for the web interface. Any [[panel]] in the project can be selected as the frontpage. When a frontpage is set, users will be presented not with the 2D map, but with the defined frontpage content instead. This allows a project creator to add a splashscreen or login page to the web interface. The ~~fronpage~~ is a separate page from the page with the 2D map. The 2D map will not be present on the frontpage. If a {{inlink\|Custom HTML\|custom panel}} is set, the custom panel will also not be present on the frontpage.		It is also possible to configure a custom frontpage for the web interface. Any [[panel]] in the project can be selected as the frontpage. When a frontpage is set, users will be presented not with the 2D map, but with the defined frontpage content instead. This allows a project creator to add a splashscreen or login page to the web interface. The frontpage is a separate page from the page with the 2D map. The 2D map will not be present on the frontpage. If a {{inlink\|Custom HTML\|custom panel}} is set, the custom panel will also not be present on the frontpage.

	{{Editor steps\|title=add a frontpage\|Create a [[panel]] with the desired content.\|Open the Web Settings panel.\|Make sure the "Front Page Panel" checkbox is checked.\|Select the desired panel in the dropdown menu.}}		{{Editor steps\|title=add a frontpage\|Create a [[panel]] with the desired content.\|Open the Web Settings panel.\|Make sure the "Front Page Panel" checkbox is checked.\|Select the desired panel in the dropdown menu.}}

	The default web interface link will link to the newly set frontpage: {{url\|link=1\|protocol=1\|append=/web/?token=~~TOKEN~~}}.		The default web interface link will link to the newly set frontpage: {{url\|link=1\|protocol=1\|append=/web/?token=WEB_TOKEN}}.

	The 2D map can still be accessed via the following direct link: {{url\|link=1\|protocol=1\|append=/web/map.html?token=~~TOKEN~~}}.		The 2D map can still be accessed via the following direct link: {{url\|link=1\|protocol=1\|append=/web/map.html?token=WEB_TOKEN}}.

	===Assets===		===Assets===
Line 94:		Line 94:
	After following these steps, the file is uploaded. The file can be accessed via a link generated by the {{software}}. The link for the asset can be obtained by selecting it in the same menu.		After following these steps, the file is uploaded. The file can be accessed via a link generated by the {{software}}. The link for the asset can be obtained by selecting it in the same menu.

	{{Editor steps\|title=obtain the url of uploaded images\|Open the Web Settings panel.\|Select the "Image URL" text area.\|In the Select Asset window, select the desired image.\|Select "Apply".\|In the Web Settings panel, the ~~url~~ is now displayed "Image URL" text area.}}		{{Editor steps\|title=obtain the url of uploaded images\|Open the Web Settings panel.\|Select the "Image URL" text area.\|In the Select Asset window, select the desired image.\|Select "Apply".\|In the Web Settings panel, the URL is now displayed in the "Image URL" text area.}}

	The ~~url~~ will be a relative ~~url~~ of the form "assets/image.png?token=$TOKEN". The full ~~url~~ will be: {{url\|link=1\|protocol=1\|append=/web/assets/image.png?token=$TOKEN}}.		The URL will be a relative URL of the form "assets/image.png?token=$TOKEN". The full URL will be: {{url\|link=1\|protocol=1\|append=/web/assets/image.png?token=$TOKEN}}.

	Note that as token "$TOKEN" is displayed. This notation is automatically replaced by the {{software}} to match the appropriate token when required. See also: {{inlink\|Using tokens in panels}}.		Note that as token "$TOKEN" is displayed. This notation is automatically replaced by the {{software}} to match the appropriate token when required. See also: {{inlink\|Using tokens in panels}}.
Line 128:		Line 128:

	===Using tokens in panels===		===Using tokens in panels===
	When using images uploaded to the {{software}}, they need to be referred to using an ~~url~~ with an authentication token. Because the authentication token will differ between stakeholders and between sessions, it's not recommended to literally place a token in those ~~urls~~ when creating panels. Instead, you can use the notation <code>$TOKEN</code>. When content, such as de CSS file or a panel is served by the {{software}}, every instance of <code>$TOKEN</code> is automatically replaced by the appropriate token.		When using images uploaded to the {{software}}, they need to be referred to using an URL with an authentication token. Because the authentication token will differ between stakeholders and between sessions, it's not recommended to literally place a token in those URL's when creating panels. Instead, you can use the notation <code>$TOKEN</code>. When content, such as de CSS file or a panel is served by the {{software}}, every instance of <code>$TOKEN</code> is automatically replaced by the appropriate token.

	==Security considerations==		==Security considerations==
	Depending on your use-case, there may be some considerations in the line of security. For sessions which are only used in closed sessions with known users or partners, these considerations may not apply. However, when offering access to a session to the general public, some consideration should be given to what information or capabilities should be provided to end-users.		Depending on your use-case, there may be some considerations in the line of security. For sessions which are only used in closed sessions with known users or partners, these considerations may not apply. However, when offering access to a session to the general public, some consideration should be given to what information or capabilities should be provided to end-users.

	An important consequence of the way the web interface is created (HTML, CSS, and Javascript) is that all code can be inspected by the end-users. This means that users can inspect the used ~~urls~~ for panels, and the way instructions to the {{software}} are structured, and from there create their own requests for information from the web interface.		An important consequence of the way the web interface is created (HTML, CSS, and Javascript) is that all code can be inspected by the end-users. This means that users can inspect the used URLs for panels, and the way instructions to the {{software}} are structured, and from there create their own requests for information from the web interface.

	===Requesting information===		===Requesting information===