From 6c030a4f1aec8a94dfdb5a55b791483b67fdb336 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Wed, 4 Dec 2024 11:30:55 +0100 Subject: [PATCH 01/10] chore: Create url-query-parameters.md Created a page that lists all available URL query parameters. --- .../for-developers/url-query-parameters.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 packages/documentation/docs/for-developers/url-query-parameters.md diff --git a/packages/documentation/docs/for-developers/url-query-parameters.md b/packages/documentation/docs/for-developers/url-query-parameters.md new file mode 100644 index 0000000000..ff8263a4dd --- /dev/null +++ b/packages/documentation/docs/for-developers/url-query-parameters.md @@ -0,0 +1,22 @@ +--- +sidebar_label: URL Query Parameters +sidebar_position: 10 +--- + +# URL Query Parameters +Appending query parameters to the URL will allow you to modify the behaviour of the GUI, as well as control the access level. + +| Query Parameter | Description | +| :---------------------------------- | :------------------------------------------------------------------------ | +| `?admin=0,1` | Default value is `0`. | +| `?studio=0,1` | Default value is `0`. | +| `?display=layout,buckets,inspector` | A comma-separated list of features to be displayed in the shelf. Available values are: `layout` \(for displaying the Rundown Layout\), `buckets` \(for displaying the Buckets\) and `inspector` \(for displaying the Inspector\). | +| `?buckets=0,1,...` | The buckets can be specified as base-0 indices of the buckets as seen by the user. This means that `?buckets=1` will display the second bucket as seen by the user when not filtering the buckets. This allows the user to decide which bucket is displayed on a secondary attached screen simply by reordering the buckets on their main view. | +| `?shelffollowsonair=0,1` | | +| `?speak=0,1` | Default value is `0`. | +| `?vibrate=0,1` | Default value is `0`. | +| `?help=0,1` | Default value is `0`. | +| `?zoom=0,1` | Default value is `0`. | +| `?show_hidden_source_layers=0,1` | Default value is `0`. | +| `?ignore_piece_content_status=0,1` | Default value is `0`. | +| `?reportNotificationsId=0,1` | Default value is `0`. | From fa2f4fe923aa5cbec422236d43db75dcadc6e269 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Wed, 4 Dec 2024 11:50:02 +0100 Subject: [PATCH 02/10] chore: Fixed capitalization in headlines --- .../docs/user-guide/features/access-levels.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/packages/documentation/docs/user-guide/features/access-levels.md b/packages/documentation/docs/user-guide/features/access-levels.md index 50307f970e..0faf2f82b6 100644 --- a/packages/documentation/docs/user-guide/features/access-levels.md +++ b/packages/documentation/docs/user-guide/features/access-levels.md @@ -15,15 +15,15 @@ The access level is persisted in browser's Local Storage. To disable, visit`?the | **Settings** | No | Yes | No | Yes | -### Basic mode +### Basic Mode Without enabling any additional modes in Sofie, the browser will have minimal access to the system. It will be able to view a rundown but, will not have the ability to manipulate it. This includes activating, deactivating, or resetting the rundown as well as taking the next part, adlib, etc. -### Studio mode +### Studio Mode Studio Mode gives the current browser full control of the studio and all information associated to it. This includes allowing actions like activating and deactivating rundowns, taking parts, adlibbing, etc. This mode is accessed by adding a `?studio=1` to the end of the URL. -### Configuration mode +### Configuration Mode Configuration mode gives the user full control over the Settings pages and allows full access to the system including the ability to modify _Blueprints_, _Studios_, or _Show Styles_, creating and restoring _Snapshots_, as well as modifying attached devices. @@ -44,3 +44,4 @@ Enables the page Test Tools, which contains various tools useful for testing the ### Developer Mode This mode will enable the browsers default right click menu to appear and can be accessed by adding `?develop=1` to the URL. It will also reveal the Manual Control section on the Rundown page. + From 97fd35d06215b5075e44381fbf04b09db5a49ca1 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Wed, 4 Dec 2024 12:22:19 +0100 Subject: [PATCH 03/10] chore: Update description of parameters Work in progress. --- .../for-developers/url-query-parameters.md | 29 ++++++++++--------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/packages/documentation/docs/for-developers/url-query-parameters.md b/packages/documentation/docs/for-developers/url-query-parameters.md index ff8263a4dd..c9fc76a557 100644 --- a/packages/documentation/docs/for-developers/url-query-parameters.md +++ b/packages/documentation/docs/for-developers/url-query-parameters.md @@ -4,19 +4,22 @@ sidebar_position: 10 --- # URL Query Parameters -Appending query parameters to the URL will allow you to modify the behaviour of the GUI, as well as control the access level. +Appending query parameter(s) to the URL will allow you to modify the behaviour of the GUI, as well as control the [access levels](../user-guide/features/access-levels.md). | Query Parameter | Description | | :---------------------------------- | :------------------------------------------------------------------------ | -| `?admin=0,1` | Default value is `0`. | -| `?studio=0,1` | Default value is `0`. | -| `?display=layout,buckets,inspector` | A comma-separated list of features to be displayed in the shelf. Available values are: `layout` \(for displaying the Rundown Layout\), `buckets` \(for displaying the Buckets\) and `inspector` \(for displaying the Inspector\). | -| `?buckets=0,1,...` | The buckets can be specified as base-0 indices of the buckets as seen by the user. This means that `?buckets=1` will display the second bucket as seen by the user when not filtering the buckets. This allows the user to decide which bucket is displayed on a secondary attached screen simply by reordering the buckets on their main view. | -| `?shelffollowsonair=0,1` | | -| `?speak=0,1` | Default value is `0`. | -| `?vibrate=0,1` | Default value is `0`. | -| `?help=0,1` | Default value is `0`. | -| `?zoom=0,1` | Default value is `0`. | -| `?show_hidden_source_layers=0,1` | Default value is `0`. | -| `?ignore_piece_content_status=0,1` | Default value is `0`. | -| `?reportNotificationsId=0,1` | Default value is `0`. | +| `admin=1` | Gives the GUI the same access as the combination of [Configuration Mode](../user-guide/features/access-levels.md#Configuration-Mode) and [Studio Mode](../user-guide/features/access-levels.md#Studio-Mode) as well as having access to a set of [Testing Mode](../user-guide/features/access-levels.md#Testing-Mode) tools and a Manual Control section on the Rundown page. _Default value is `0`._ | +| `studio=1` | [Studio Mode](../user-guide/features/access-levels.md#Studio-Mode) gives the GUI full control of the studio and all information associated to it. This includes allowing actions like activating and deactivating rundowns, taking parts, adlibbing, etcetera. _Default value is `0`._ | +| `buckets=0,1,...` | The buckets can be specified as base-0 indices of the buckets as seen by the user. This means that `?buckets=1` will display the second bucket as seen by the user when not filtering the buckets. This allows the user to decide which bucket is displayed on a secondary attached screen simply by reordering the buckets on their main view. | +| `display=layout,buckets,inspector` | A comma-separated list of features to be displayed in the shelf. Available values are: `layout` \(for displaying the Rundown Layout\), `buckets` \(for displaying the Buckets\) and `inspector` \(for displaying the Inspector\). | +| `help=1` | Enables some tooltips that might be useful to new users. _Default value is `0`._ | +| `ignore_piece_content_status=1` | Removes the "zebra" marking on VT pieces that have a "missing" status. _Default value is `0`._ | +| `reportNotificationsId=0,1,...` | Allows you to set a specific `reportNotificationsId`. _Default value is `0`, meaning the that default ID (i.e. not `0`) will be used._ | +| `shelffollowsonair=1` | _Default value is `0`._ | +| `show_hidden_source_layers=1` | _Default value is `0`._ | +| `speak=1` | _Default value is `0`._ | +| `vibrate=1` | _Default value is `0`._ | +| `zoom=1` | _Default value is `0`._ | + + + From 51bdcff1a204d976c550e49c50d6146826e2044d Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Wed, 4 Dec 2024 19:28:02 +0100 Subject: [PATCH 04/10] chore: Additional URL parameter info Updated the "zoom" parameter. --- .../documentation/docs/for-developers/url-query-parameters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation/docs/for-developers/url-query-parameters.md b/packages/documentation/docs/for-developers/url-query-parameters.md index c9fc76a557..0281d81cf3 100644 --- a/packages/documentation/docs/for-developers/url-query-parameters.md +++ b/packages/documentation/docs/for-developers/url-query-parameters.md @@ -19,7 +19,7 @@ Appending query parameter(s) to the URL will allow you to modify the behaviour o | `show_hidden_source_layers=1` | _Default value is `0`._ | | `speak=1` | _Default value is `0`._ | | `vibrate=1` | _Default value is `0`._ | -| `zoom=1` | _Default value is `0`._ | +| `zoom=1,...` | Sets the scaling of the entire GUI. _The unit is a percentage where `100` is the default scaling._ | From 98693365983ddf3fe71797f824232298d39d16eb Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 5 Dec 2024 10:04:52 +0100 Subject: [PATCH 05/10] chore: Add cross-link to URL parameters page --- .../documentation/docs/user-guide/features/access-levels.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/documentation/docs/user-guide/features/access-levels.md b/packages/documentation/docs/user-guide/features/access-levels.md index 0faf2f82b6..0aad239095 100644 --- a/packages/documentation/docs/user-guide/features/access-levels.md +++ b/packages/documentation/docs/user-guide/features/access-levels.md @@ -45,3 +45,6 @@ Enables the page Test Tools, which contains various tools useful for testing the This mode will enable the browsers default right click menu to appear and can be accessed by adding `?develop=1` to the URL. It will also reveal the Manual Control section on the Rundown page. +### See Also + +[URL Query Parameters](../for-developers/url-query-parameters.md) From 8679d157c3fa81e59462fb76fd51c49a6a0ef31d Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 5 Dec 2024 10:05:53 +0100 Subject: [PATCH 06/10] chore: Fixed bad link --- .../documentation/docs/user-guide/features/access-levels.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation/docs/user-guide/features/access-levels.md b/packages/documentation/docs/user-guide/features/access-levels.md index 0aad239095..830a30153c 100644 --- a/packages/documentation/docs/user-guide/features/access-levels.md +++ b/packages/documentation/docs/user-guide/features/access-levels.md @@ -47,4 +47,4 @@ This mode will enable the browsers default right click menu to appear and can be ### See Also -[URL Query Parameters](../for-developers/url-query-parameters.md) +[URL Query Parameters](../../for-developers/url-query-parameters.md) From d9c6cc878977644ccac384a1f39d0c06c0fa2e12 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 5 Dec 2024 10:09:33 +0100 Subject: [PATCH 07/10] chore: Updated URL params content --- .../docs/for-developers/url-query-parameters.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/packages/documentation/docs/for-developers/url-query-parameters.md b/packages/documentation/docs/for-developers/url-query-parameters.md index 0281d81cf3..104fe42cb5 100644 --- a/packages/documentation/docs/for-developers/url-query-parameters.md +++ b/packages/documentation/docs/for-developers/url-query-parameters.md @@ -4,13 +4,14 @@ sidebar_position: 10 --- # URL Query Parameters -Appending query parameter(s) to the URL will allow you to modify the behaviour of the GUI, as well as control the [access levels](../user-guide/features/access-levels.md). +Appending query parameter(s) to the URL will allow you to modify the behaviour of the GUI, as well as control the [Access Levels](../user-guide/features/access-levels.md). | Query Parameter | Description | | :---------------------------------- | :------------------------------------------------------------------------ | | `admin=1` | Gives the GUI the same access as the combination of [Configuration Mode](../user-guide/features/access-levels.md#Configuration-Mode) and [Studio Mode](../user-guide/features/access-levels.md#Studio-Mode) as well as having access to a set of [Testing Mode](../user-guide/features/access-levels.md#Testing-Mode) tools and a Manual Control section on the Rundown page. _Default value is `0`._ | | `studio=1` | [Studio Mode](../user-guide/features/access-levels.md#Studio-Mode) gives the GUI full control of the studio and all information associated to it. This includes allowing actions like activating and deactivating rundowns, taking parts, adlibbing, etcetera. _Default value is `0`._ | | `buckets=0,1,...` | The buckets can be specified as base-0 indices of the buckets as seen by the user. This means that `?buckets=1` will display the second bucket as seen by the user when not filtering the buckets. This allows the user to decide which bucket is displayed on a secondary attached screen simply by reordering the buckets on their main view. | +| `develop=1` | Enables the browser's default right-click menu to appear. It will also reveal the _Manual Control_ section on the Rundown page. _Default value is `0`._ | | `display=layout,buckets,inspector` | A comma-separated list of features to be displayed in the shelf. Available values are: `layout` \(for displaying the Rundown Layout\), `buckets` \(for displaying the Buckets\) and `inspector` \(for displaying the Inspector\). | | `help=1` | Enables some tooltips that might be useful to new users. _Default value is `0`._ | | `ignore_piece_content_status=1` | Removes the "zebra" marking on VT pieces that have a "missing" status. _Default value is `0`._ | @@ -18,8 +19,8 @@ Appending query parameter(s) to the URL will allow you to modify the behaviour o | `shelffollowsonair=1` | _Default value is `0`._ | | `show_hidden_source_layers=1` | _Default value is `0`._ | | `speak=1` | _Default value is `0`._ | +| `theaccessmode=0` | If user accounts are enabled \(`enableUserAccounts` in [_Sofie Core_ settings](../configuration/sofie-core-settings#settings-file)\), the [access levels](../user-guide/features/access-levels.md) are set under the user settings. If no user accounts are set, the access level for a browser is set by adding `?theaccessmode=1` to the URL. The access level is persisted in browser's Local Storage. To disable; add the URL query parameter `?theaccessmode=0`. _Default value is `1`._ | | `vibrate=1` | _Default value is `0`._ | | `zoom=1,...` | Sets the scaling of the entire GUI. _The unit is a percentage where `100` is the default scaling._ | - From 25d514ade445135265eae4e6f1c2ba1b316b522e Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 5 Dec 2024 15:24:42 +0100 Subject: [PATCH 08/10] chore: Updated vibrate and speak content --- .../documentation/docs/for-developers/url-query-parameters.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/documentation/docs/for-developers/url-query-parameters.md b/packages/documentation/docs/for-developers/url-query-parameters.md index 104fe42cb5..24d0fa49ca 100644 --- a/packages/documentation/docs/for-developers/url-query-parameters.md +++ b/packages/documentation/docs/for-developers/url-query-parameters.md @@ -18,9 +18,9 @@ Appending query parameter(s) to the URL will allow you to modify the behaviour o | `reportNotificationsId=0,1,...` | Allows you to set a specific `reportNotificationsId`. _Default value is `0`, meaning the that default ID (i.e. not `0`) will be used._ | | `shelffollowsonair=1` | _Default value is `0`._ | | `show_hidden_source_layers=1` | _Default value is `0`._ | -| `speak=1` | _Default value is `0`._ | +| `speak=1` | Experimental feature that starts playing an audible countdown 10 seconds before each planned _Take_. __Default value is `0`._ | | `theaccessmode=0` | If user accounts are enabled \(`enableUserAccounts` in [_Sofie Core_ settings](../configuration/sofie-core-settings#settings-file)\), the [access levels](../user-guide/features/access-levels.md) are set under the user settings. If no user accounts are set, the access level for a browser is set by adding `?theaccessmode=1` to the URL. The access level is persisted in browser's Local Storage. To disable; add the URL query parameter `?theaccessmode=0`. _Default value is `1`._ | -| `vibrate=1` | _Default value is `0`._ | +| `vibrate=1` | Experimental feature that triggers the vibration API in the web browser 3 seconds before each planned _Take_. _Default value is `0`._ | | `zoom=1,...` | Sets the scaling of the entire GUI. _The unit is a percentage where `100` is the default scaling._ | From 53af0eef8db4b0098d00311ba46b52ac2645a38f Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 9 Dec 2024 14:41:56 +0100 Subject: [PATCH 09/10] chore: Remove one parameter, clarified the use of another --- .../documentation/docs/for-developers/url-query-parameters.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/documentation/docs/for-developers/url-query-parameters.md b/packages/documentation/docs/for-developers/url-query-parameters.md index 24d0fa49ca..e4833df651 100644 --- a/packages/documentation/docs/for-developers/url-query-parameters.md +++ b/packages/documentation/docs/for-developers/url-query-parameters.md @@ -15,11 +15,10 @@ Appending query parameter(s) to the URL will allow you to modify the behaviour o | `display=layout,buckets,inspector` | A comma-separated list of features to be displayed in the shelf. Available values are: `layout` \(for displaying the Rundown Layout\), `buckets` \(for displaying the Buckets\) and `inspector` \(for displaying the Inspector\). | | `help=1` | Enables some tooltips that might be useful to new users. _Default value is `0`._ | | `ignore_piece_content_status=1` | Removes the "zebra" marking on VT pieces that have a "missing" status. _Default value is `0`._ | -| `reportNotificationsId=0,1,...` | Allows you to set a specific `reportNotificationsId`. _Default value is `0`, meaning the that default ID (i.e. not `0`) will be used._ | +| `reportNotificationsId=1,...` | Sets a specific ID of the client GUI. Useful for troubleshooting since this ID shows up in _Sofie Core_'s log. _Default value is "0", which disables the feature and uses a user-defined string (user as-in whoever is opening the client GUI, not necessarily the actual end-user)._ | | `shelffollowsonair=1` | _Default value is `0`._ | | `show_hidden_source_layers=1` | _Default value is `0`._ | | `speak=1` | Experimental feature that starts playing an audible countdown 10 seconds before each planned _Take_. __Default value is `0`._ | -| `theaccessmode=0` | If user accounts are enabled \(`enableUserAccounts` in [_Sofie Core_ settings](../configuration/sofie-core-settings#settings-file)\), the [access levels](../user-guide/features/access-levels.md) are set under the user settings. If no user accounts are set, the access level for a browser is set by adding `?theaccessmode=1` to the URL. The access level is persisted in browser's Local Storage. To disable; add the URL query parameter `?theaccessmode=0`. _Default value is `1`._ | | `vibrate=1` | Experimental feature that triggers the vibration API in the web browser 3 seconds before each planned _Take_. _Default value is `0`._ | | `zoom=1,...` | Sets the scaling of the entire GUI. _The unit is a percentage where `100` is the default scaling._ | From 6ada91ca449ac23acfe2a56267e550cea47002a3 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Mon, 9 Dec 2024 14:43:51 +0100 Subject: [PATCH 10/10] chore: Fixed text styling --- .../documentation/docs/for-developers/url-query-parameters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/documentation/docs/for-developers/url-query-parameters.md b/packages/documentation/docs/for-developers/url-query-parameters.md index e4833df651..fe9aa1c5fa 100644 --- a/packages/documentation/docs/for-developers/url-query-parameters.md +++ b/packages/documentation/docs/for-developers/url-query-parameters.md @@ -18,7 +18,7 @@ Appending query parameter(s) to the URL will allow you to modify the behaviour o | `reportNotificationsId=1,...` | Sets a specific ID of the client GUI. Useful for troubleshooting since this ID shows up in _Sofie Core_'s log. _Default value is "0", which disables the feature and uses a user-defined string (user as-in whoever is opening the client GUI, not necessarily the actual end-user)._ | | `shelffollowsonair=1` | _Default value is `0`._ | | `show_hidden_source_layers=1` | _Default value is `0`._ | -| `speak=1` | Experimental feature that starts playing an audible countdown 10 seconds before each planned _Take_. __Default value is `0`._ | +| `speak=1` | Experimental feature that starts playing an audible countdown 10 seconds before each planned _Take_. _Default value is `0`._ | | `vibrate=1` | Experimental feature that triggers the vibration API in the web browser 3 seconds before each planned _Take_. _Default value is `0`._ | | `zoom=1,...` | Sets the scaling of the entire GUI. _The unit is a percentage where `100` is the default scaling._ |