chore: Update and rename sofie-views.mdx to sofie-views-and-screens.mdx

hummelstrand · Saftret · commit d61b92f639dc · 2025-04-10T19:53:55.000+02:00
Clarified structure and named views/screens/modes consistently.
diff --git a/packages/documentation/docs/user-guide/features/sofie-views-and-screens.mdx b/packages/documentation/docs/user-guide/features/sofie-views-and-screens.mdx
@@ -5,7 +5,13 @@ sidebar_position: 2
 import Tabs from '@theme/Tabs'
 import TabItem from '@theme/TabItem'
 
-# Sofie Views
+# Sofie Views and Screens
+
+ ## Definitions
+ * A _**View**_ is definied as a particular layout of Sofie's main user interface.
+ 	* A _**Mode**_ is one of several ways to configure a particular "View" of Sofie's main user interface.
+   * A _**Panel**_ is defined as an expandable/collapsable area of Sofie's main user interface.
+ * A _**Screen**_ is defined a layout intended to be used on an external display, in addition to with Sofie's main user interface.
 
 ## Lobby View
 
@@ -19,7 +25,7 @@ All existing rundowns are listed in the _Lobby View_.
 
 The _Rundown View_ is the main view that the producer is working in.
 
-![The Rundown view and naming conventions of components](/img/docs/main/sofie-naming-conventions.png)
+![The Rundown View and naming conventions of components](/img/docs/main/sofie-naming-conventions.png)
 
 ![Take Next](/img/docs/main/take-next.png)
 
@@ -52,6 +58,18 @@ If a Piece has more or less content than the Part's expected duration allows, an
 
 Elements in the [Next point](#next-point) \(or beyond\) might be pre-loaded or "put on preview", depending on the blueprints and playout devices used. This feature is called "Lookahead".
 
+### Rundown View Modes
+In the top-right corner of the Segment, there's a button controlling the display style of a given Segment. The default display style of a Segment can be indicated by the [Blueprints](../concepts-and-architecture.md#blueprints), but the user can switch to a different mode at any time. You can also change the display mode of all Segments at once, using a button in the bottom-right corner of the Rundown View.
+
+All user interactions work in the Storyboard Mode and List Mode the same as in Timeline Mode: Takes, AdLibs, Holds, and moving the [Next Point](#next-point) around the Rundown.
+
+
+ #### Timeline Mode
+ The default mode for the Rundown.
+
+
+ #### Storyboard Mode
+
 ### Storyboard Mode
 
 In the top-right corner of the Segment, there's a button controlling the display style of a given Segment. The default display style of a Segment can be indicated by the [Blueprints](../concepts-and-architecture.md#blueprints), but the User can switch to a different mode at any time. You can also change the display mode of all Segments at once, using a button in the bottom-right corner of the Rundown View.
@@ -60,21 +78,21 @@ In the top-right corner of the Segment, there's a button controlling the display
 
 The **_Storyboard_** mode is an alternative to the default **_Timeline_** mode. In Storyboard mode, the accurate placement in time of each Piece is not visualized, so that more Parts can be visualized at once in a single row. This can be particularly useful in Shows without very strict timing planning or where timing is not driven by the User, but rather some external factor; or in Shows where very long Parts are joined with very short ones: sports, events and debates. This mode also does not visualize the history of the playback: rather, it only shows what is currently On Air or is planned to go On Air.
 
-Storyboard mode selects a "main" Piece of the Part, using the same logic as the [Presenter View](#presenter-view), and presents it with a larger, hover-scrub-enabled Piece for easy preview. The countdown to freeze-frame is displayed in the top-right hand corner of the Thumbnail, once less than 10 seconds remain to freeze-frame. The Transition Piece is displayed on top of the thumbnail. Other Pieces are placed below the thumbnail, stacked in order of playback. After a Piece goes off-air, it will dissapear from the view.
+Storyboard mode selects a "main" Piece of the Part, using the same logic as the [Presenter Screen](#presenter-screen), and presents it with a larger, hover-scrub-enabled Piece for easy preview. The countdown to freeze-frame is displayed in the top-right hand corner of the Thumbnail, once less than 10 seconds remain to freeze-frame. The Transition Piece is displayed on top of the thumbnail. Other Pieces are placed below the thumbnail, stacked in order of playback. After a Piece goes off-air, it will dissapear from the view.
 
 If no more Parts can be displayed in a given Segment, they are stacked in order on the right side of the Segment. The User can scroll through thse Parts by click-and-dragging the Storyboard area, or using the mouse wheel - `Alt`+Wheel, if only a vertical wheel is present in the mouse.
 
-### List View Mode
+#### List Mode
 
-Another mode available to display a Segment is the List View. In this mode, each _Part_ and it's contents are being displayed as a mini-timeline and it's width is normalized to fit the screen, unless it's shorter than 30 seconds, in which case it will be scaled down accordingly.
+Another mode available to display a Segment is the List Mode. In this mode, each _Part_ and it's contents are being displayed as a mini-timeline and it's width is normalized to fit the screen, unless it's shorter than 30 seconds, in which case it will be scaled down accordingly.
 
-![List View Mode](/img/docs/main/list_view.png)
+![List Mode](/img/docs/main/list_view.png)
 
 In this mode, the focus is on the "main" Piece of the Part. Additional _Lower-Third_ Pieces will be displayed on top of the main Piece. Infinite _Lower-Third_ Pieces and all other content can be displayed to the right of the mini-timeline as a set of indicators, one per every Layer. Clicking on those indicators will show a pop-up with the Pieces so that they can be investigated using _hover-scrub_. Indicators can be also shown for Ad-Libs assigned to a Part, for easier discovery by the User. Which Layers should be shown in the columns can be decided in the [Settings ● Layers](../configuration/settings-view.md#show-style) area. A special, larger indicator is reserved for the Script piece, which can be useful to display so-called _out-words_.
 
 If a Part has an _in-transition_ Piece, it will be displayed to the left of the Part's Take Point.
 
-This view is designed to be used in productions that are mixing pre-planned and timed segments with more free-flowing production or mixing short live in-camera links with longer pre-produced clips, while trying to keep as much of the show in the viewport as possible, at the expense of hiding some of the content from the User and the _duration_ of the Part on screen having no bearing on it's _width_. This mode also allows Sofie to visualize content _beyond_ the planned duration of a Part.
+This List Mode is designed to be used in productions that are mixing pre-planned and timed segments with more free-flowing production or mixing short live in-camera links with longer pre-produced clips, while trying to keep as much of the show in the viewport as possible, at the expense of hiding some of the content from the User and the _duration_ of the Part on screen having no bearing on it's _width_. This mode also allows Sofie to visualize content _beyond_ the planned duration of a Part.
 
 :::info
 The Segment header area also shows the expected (planned) durations for all the Parts and will also show which Parts are sharing timing in a timing group using a *⌊* symbol in the place of a counter.
@@ -84,7 +102,7 @@ All user interactions work in the Storyboard and List View mode the same as in T
 
 ### Segment Header Countdowns
 
-![Each Segment has two clocks - the Segment Time Budget and a Segment Countdown](/img/docs/main/segment-budget-and-countdown.png)
+![Each Segment has two clocks — the Segment Time Budget and a Segment Countdown](/img/docs/main/segment-budget-and-countdown.png)
 
 <Tabs>
 <TabItem value="segment-time-budget" label="Left: Segment Time Budget" default>
@@ -128,13 +146,13 @@ The _Rundown View_ and the _Detached Shelf View_ UI can have multiple concurrent
 2. select the first layout of any type,
 3. use the default layout \(no additional filters\), in the style of `RUNDOWN_LAYOUT`.
 
-To use a specific layout in these views, you can use the `?layout=...` query string, providing either the ID of the layout or a part of the name. This string will then be mached against all available layouts for the Show Style, and the first matching will be selected. For example, for a layout called `Stream Deck layout`, to open the currently active rundown's Detached Shelf use:
+To use a specific mode in these views, you can use the `?layout=...` query string, providing either the ID of the layout or a part of the name. This string will then be mached against all available layouts for the Show Style, and the first matching will be selected. For example, for a layout called `Stream Deck layout`, to open the currently active rundown's Detached Shelf use:
 
 `http://localhost:3000/activeRundown/studio0/shelf?layout=Stream`
 
-The Detached Shelf view with a custom `DASHBOARD_LAYOUT` allows displaying the Shelf on an auxiliary touch screen, tablet or a Stream Deck device. A specialized Stream Deck view will be used if the view is opened on a device with hardware characteristics matching a Stream Deck device.
+The Detached Shelf Screen with a custom `DASHBOARD_LAYOUT` allows displaying the Shelf on an auxiliary touch screen, tablet or a Stream Deck device. A specialized Stream Deck view will be used if the view is opened on a device with hardware characteristics matching a Stream Deck device.
 
-The shelf also contains additional elements, not controlled by the Rundown View Layout. These include Buckets and the Inspector. If needed, these components can be displayed or hidden using additional url arguments:
+The shelf also contains additional elements, not controlled by the Rundown View Mode. These include Buckets and the Inspector. If needed, these components can be displayed or hidden using additional url arguments:
 
 | Query parameter                     | Description                                                               |
 | :---------------------------------- | :------------------------------------------------------------------------ |
@@ -163,7 +181,7 @@ The Switchboard panel can be accessed from the Rundown View's right-hand Toolbar
 Technically, the switchboard activates and deactivates Route Sets. The Route Sets are grouped by Exclusivity Group. If an Exclusivity Group contains exactly two elements with the `ACTIVATE_ONLY` mode, the Route Sets will be displayed on either side of the switch. Otherwise, they will be displayed separately in a list next to an _Off_ position. See also [Settings ● Route sets](../configuration/settings-view#route-sets).
 :::
 
-#### Media Status panel
+#### Media Status Panel
 
 ![Media Status panel](/img/docs/main/features/media-status-rundown-view-panel.png)
 
@@ -175,81 +193,97 @@ Note that while the _Filter..._ text field is focused, you will not be able to
 use hotkey triggers for playout actions. You can remove the focus from the field
 by pressing the <kbd>Esc</kbd> key.
 
-## Prompter View
+
+## Evaluations
+
+When a broadcast is done, users can input feedback about how the show went in an evaluation form.
+
+:::info
+Evaluations can be configured to be sent to Slack, by setting the "Slack Webhook URL" in the [Settings View](../configuration/settings-view.md) under _Studio_.
+:::
+
+## Settings View
+
+The [Settings View](../configuration/settings-view.md) is only available to users with the [Access Level](access-levels.md) set correctly.
+
+
+ ## Screens
+
+ ### Prompter Screen
 
 `/prompter/:studioId`
 
-![Prompter View](/img/docs/main/features/prompter-example.png)
+![Prompter Screen](/img/docs/main/features/prompter-example.png)
 
 A fullscreen page which displays the prompter text for the currently active rundown. The prompter can be controlled and configured in various ways, see more at the [Prompter](prompter.md) documentation. If no Rundown is active in a given studio, the [Screensaver](sofie-views.mdx#screensaver) will be displayed.
 
-## Presenter View
+### Presenter Screen
 
 `/countdowns/:studioId/presenter`
 
-![Presenter View](/img/docs/main/features/presenter-screen-example.png)
+![Presenter Screen](/img/docs/main/features/presenter-screen-example.png)
 
-A fullscreen page, intended to be shown to the studio presenter. It displays countdown timers for the current and next items in the rundown. If no Rundown is active in a given studio, the [Screensaver](sofie-views.mdx#screensaver) will be shown.
+A fullscreen page, intended to be shown to the studio presenter. It displays countdown timers for the current and next items in the rundown. If no Rundown is active in a given studio, the [Screensaver](sofie-views-and-screens.mdx#screensaver) will be shown.
 
-### Presenter View Overlay
+#### Presenter Screen Overlay
 
 `/countdowns/:studioId/overlay`
 
-![Presenter View Overlay](/img/docs/main/features/presenter-screen-overlay-example.png)
+![Presenter Screen Overlay](/img/docs/main/features/presenter-screen-overlay-example.png)
 
-A fullscreen view with transparent background, intended to be shown to the studio presenter as an overlay on top of the produced PGM signal. It displays a reduced amount of the information from the regular [Presenter screen](sofie-views.mdx#presenter-view): the countdown to the end of the current Part, a summary preview \(type and name\) of the next item in the Rundown and the current time of day. If no Rundown is active it will show the name of the Studio.
+A fullscreen page with transparent background, intended to be shown to the studio presenter as an overlay on top of the produced PGM signal. It displays a reduced amount of the information from the regular [Presenter Screen](sofie-views-and-screens.mdx#presenter-screen): the countdown to the end of the current Part, a summary preview \(type and name\) of the next item in the Rundown and the current time of day. If no Rundown is active it will show the name of the Studio.
 
-## Camera Position View
+### Camera Position Screen
 
 `/countdowns/:studioId/camera`
 
-![Camera Position View](/img/docs/main/features/camera-view.jpg)
+![Camera Position Screen](/img/docs/main/features/camera-view.jpg)
 
-A fullscreen view designed specifically for use on mobile devices or extra screens displaying a summary of the currently active Rundown, filtered for Parts containing Pieces matching particular Source Layers and Studio Labels.
+A fullscreen page designed specifically for use on mobile devices or extra screens displaying a summary of the currently active Rundown, filtered for Parts containing Pieces matching particular Source Layers and Studio Labels.
 
 The Pieces are displayed as a Timeline, with the Pieces moving right-to-left as time progresses, and Parts being displayed from the current one being played up till the end of the Rundown. The closest (not necessarily _Next_) Part has a countdown timer in the top-right corner showing when it's expected to be Live. Each Part also has a Duration counter on the bottom-right.
 
-This view can be configured using query parameters:
+This screen can be configured using query parameters:
 
 | Query parameter | Type | Description | Default |
 | :-------------- | :--- | :---------- | :------ |
 | `sourceLayerIds` | string | A comma-separated list of Source Layer IDs to be considered for display | _(show all)_ |
 | `studioLabels` | string | A comma-separated list of Studio Labels (Piece `.content.studioLabel` values) to be considered for display | _(show all)_ |
-| `fullscreen` | 0 / 1 | Should the view become fullscreen on the device on first user interaction | 0 |
+| `fullscreen` | 0 / 1 | Should the screen be shown fullscreen on the device on first user interaction | 0 |
 
 Example: [http://127.0.0.1/countdowns/studio0/camera?sourceLayerIds=camera0,dve0&studioLabels=1,KAM%201,K1,KAM1&fullscreen=1](http://127.0.0.1/countdowns/studio0/camera?sourceLayerIds=camera0,dve0&studioLabels=1,KAM%201,K1,KAM1&fullscreen=1)
 
-## Active Rundown View
+### Active Rundown Screen
 
 `/activeRundown/:studioId`
 
-![Active Rundown View](/img/docs/main/features/active-rundown-example.png)
+![Active Rundown Screen](/img/docs/main/features/active-rundown-example.png)
 
 A page which automatically displays the currently active rundown. Can be useful for the producer to have on a secondary screen.
 
-## Active Rundown – Shelf
+### Active Rundown Shelf Screen
 
 `/activeRundown/:studioId/shelf`
 
 ![Active Rundown Shelf](/img/docs/main/features/active-rundown-shelf-example.png)
 
-A view which automatically displays the currently active rundown, and shows the Shelf in full screen. Can be useful for the producer to have on a secondary screen.
+A screen which automatically displays the currently active rundown, and shows the Shelf in fullscreen. Can be useful for the producer to have on a secondary screen.
 
 A shelf layout can be selected by modifying the query string, see [Shelf Layouts](#shelf-layouts).
 
-## Specific Rundown – Shelf
+### Specific Rundown Shelf Screen
 
 `/rundown/:rundownId/shelf`
 
-Displays the shelf in fullscreen for a rundown
+Displays the Shelf in fullscreen for a rundown.
 
-## Screensaver
+### Screensaver
 
-When big screen displays \(like Prompter and the Presenter screen\) do not have any meaningful content to show, an animated screensaver showing the current time and the next planned show will be displayed. If no Rundown is upcoming, the Studio name will be displayed.
+When big screen displays \(like Prompter Screen and the Presenter Screen\) do not have any meaningful content to show, an animated screensaver showing the current time and the next planned show will be displayed. If no Rundown is upcoming, the Studio name will be displayed.
 
 ![A screensaver showing the next scheduled show](/img/docs/main/features/next-scheduled-show-example.png)
 
-## System Status
+### System Status Screen
 
 :::caution
 Documentation for this feature is yet to be written.
@@ -261,23 +295,23 @@ System and devices statuses are displayed here.
 An API endpoint for the system status is also available under the URL `/health`
 :::
 
-## Media Status View
+### Media Status Screen
 
-This view is a summary of all the media required for playback for Rundowns 
+This screen is a summary of all the media required for playback for Rundowns 
 present in this System. This view allows you to see if clips are ready for 
 playback or if they are still waiting to become available to be transferred 
 onto a playout system.
 
-![Media Status page](/img/docs/main/features/media-status.png)
+![Media Status Screen](/img/docs/main/features/media-status.png)
 
 By default, the Media items are sorted according to their position in the
 rundown, and the rundowns are in the same order as in the [Lobby View]
 (#lobby-view). You can change the sorting order by clicking on the buttons in 
 the table header.
 
-Rundown View also has a panel that presents this information in the [context of the current Rundown](#media-status-panel).
+The Rundown View also has a panel that presents this information in the [context of the current Rundown](#media-status-panel).
 
-## Message Queue View
+### Message Queue Screen
 
 :::caution
 Documentation for this feature is yet to be written.
@@ -289,13 +323,13 @@ These messages are retained for a period of time, and can be reviewed in this li
 
 Messages that was not successfully sent can be inspected and re-sent here.
 
-## User Log View
+### User Log Screen
 
-The user activity log contains a list of the user-actions that users have previously done. This is used in troubleshooting issues on-air.
+The user activity log contains a list of the user-actions that users have previously done. This is used in troubleshooting issues while on air.
 
 ![User Log](/img/docs/main/features/user-log.png)
 
-### Columns, explained
+#### Columns, explained
 
 #### Execution time
 
