You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user-guide/04-desks-and-custom-workspaces.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,49 +4,49 @@ Desks are the basic organisational units in Superdesk. Desks are like the depart
4
4
5
5
All users are assigned to a Desk. Some users may be assigned to multiple Desks. News items that users create, fetch, edit, spike or publish become associated with their current Desk. Users may be assigned to more than one desk at a time.
6
6
7
-
7
+
8
8
9
9
The Desks menu is beside the Hamburger Menu in the top-left corner of the Superdesk interface. It always displays the name of the desk or workspace that you’re currently working on.
10
10
11
11
Clicking on the Desks menu will show a list of desks that you currently belong to, as well as your Custom Workspaces. Desks you belong to are displayed in blue and Custom Workspaces are displayed in purple. It’s possible to have more than one Custom Workspace. Multiple Custom Workspaces are especially useful if you’re working on more than one desk or project at the same time.
12
12
13
13
Some news items arrive at a desk after they have been selected by a user from an external source in the Search tab. Many of the news items in the Search tab may have been authored by outside sources (such as news agencies). The process of moving an article from the Search tab to a desk is called **fetching**. It is not possible to fetch articles from external sources to your Custom Workspace. You can only fetch articles to a Desk. It is possible that the same news item could be fetched to multiple desks.
14
14
15
-
 This is the Dashboard icon from the Workspace panel.
15
+
 This is the Dashboard icon from the Workspace panel.
16
16
17
17
Users working on the same desk will see the same widget configuration on their desk Dashboard. Only administrators can add or change widgets on a Desk Dashboard.
18
18
Custom Workspaces also have Dashboards. If a user would like custom widgets, they can set them up using their Custom Workspace Dashboard.
19
19
20
-
 This is the Personal Space icon found on the Workspace Panel.
20
+
 This is the Personal Space icon found on the Workspace Panel.
21
21
22
22
Personal Space is a place where journalists can create items in full privacy. Articles that are created in your Personal Space tab are not visible to anyone but you, and will not show up in Global Searches. They will not be visible to anyone else until you choose to send them to a Desk. Your Personal Space can also be accessed from the Hamburger menu.
23
23
24
-
 This is an Action menu icon.
24
+
 This is an Action menu icon.
25
25
26
26
You will find Action menus in various locations throughout the Superdesk interface.
27
27
28
-
28
+
29
29
30
30
When you hover over an item that you saved either in your Personal Space or on a Desk, an Action menu icon will appear on the right. Click on the Action menu to perform actions such as editing, copying and spiking.
31
31
32
-
 This is the Spike tab in the Workspace Panel.
32
+
 This is the Spike tab in the Workspace Panel.
33
33
34
34
When you spike an item from your Personal Space, it will not show up in the spiked items section and it cannot be recovered.
35
35
When you spike a news item from a desk, it will show up in the Spiked items tab associated with that desk. The Spike tab is equivalent to a trash bin or recycle bin on your operating system of choice. Spiking can be reversed and news items can be restored to the workflow at any time.
36
36
If your Desk has a content expiry, and the news item reaches the expiry limit, it will be deleted permanently if it remains on the Desk past the expiry deadline.
37
37
38
-
 You will find the *Send To* icon in the top right corner of items that are open for editing.
38
+
 You will find the *Send To* icon in the top right corner of items that are open for editing.
39
39
40
40
To send an article from your Personal Space to a Desk, click *Edit* in the Action menu, then in the article window, click the purple *Send To* button. It’s possible to send news items that you have created in your Personal Space to Desks that you are not a member of, but if you do, you will not be able to access the article when it is on a Desk that you are not a member of.
41
41
42
-
42
+
43
43
44
44
When you are editing articles, if you do not click the *Close* button but navigate away from the article, it will automatically minimise at the bottom of the Superdesk interface in the Workspace Bar. Minimised articles remain locked from other users until they are closed (either by the current user, or manually unlocked by a desk manager).
45
45
46
-
 This is the Open Items icon.
46
+
 This is the Open Items icon.
47
47
48
48
You can view all your currently open items in a grid-view by clicking on the Open Items icon in the Workspace Bar at bottom left of the Superdesk interface.
49
49
50
-
50
+
51
51
52
52
Clicking on the *Open Items* icon will navigate you to a new window showing all your open articles. Clicking on one of the articles will take you back to the main Workspace and open the article that you’ve selected. You can exit the *Open Items* view by clicking on the *X* in the top right corner of the main window.
Copy file name to clipboardExpand all lines: docs/user-guide/05-dashboards-and-widgets.md
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,58 +1,58 @@
1
1
# Dashboards and Widgets
2
2
3
-
 You will find your Dashboard icon on your Workspace Panel.
3
+
 You will find your Dashboard icon on your Workspace Panel.
4
4
5
5
The Dashboards for shared Desks are pre-configured by administrators (or other users with the required privileges, such as bureau chiefs, desk heads, etc). The Dashboard is designed to give a quick overview of information that matters for the respective desk’s members. Users are able to configure the Dashboards in their Custom Workspaces. You can return to your Dashboard by clicking the home-shaped icon in the Workspace Panel, on the left.
6
6
7
7
You can only view the Dashboards for Desks to which you are assigned. Every user can also have a Custom Workspace which is only accessible to them, on which they can have customized widgets to suit their needs, for example monitoring several different Desks in one place. Standard Dashboard widgets are explained in detail in this section of the Superdesk manual. Your Superdesk instance might also have custom widgets.
8
8
9
-
9
+
10
10
11
11
Beside the Hamburger Menu, you’ll see the blue drop-down Desks menu. It will display the name of the desk you’re currently working on. Click on the desk name and you’ll be able to view all desks you’re assigned to. Desks can be configured by editors/managers to have different Dashboard setups depending on the needs of your team.
12
12
13
13
Changes that are made to a Dashboard on a Desk will be visible to all users assigned to that Desk. Widgets on the Dashboard of your Custom Workspace are visible only to you.
14
14
15
-
 This is the Create icon.
15
+
 This is the Create icon.
16
16
17
17
When you are on a Dashboard, you will see the Create icon in the top right corner of the Dashboard pane, just below your user icon.
18
18
19
-
19
+
20
20
21
21
If you have the appropriate privileges, you can customise the widgets on your Desk Dashboard by clicking the Create icon at the top-right section of the pane. When you click the Create icon, a new window with widget options will open. Select the widget that you would like to add to your Dashboard, then click *add this widget.* Once you’ve selected the widget you would like to add, click the *Insert this Widget* button to place the widget on your Dashboard. You can add multiple displays of the same type of widget to any Dashboard.
22
22
23
23
You can arrange the widgets on your Dashboard in any configuration you like.
24
24
25
-
 This is the Rearrange Widgets icon.
25
+
 This is the Rearrange Widgets icon.
26
26
27
27
Click the *Rearrange Widgets* button at the top-right corner of the main interface, then select and drag a widget to the desired area of your Dashboard to place it.
28
28
29
-
29
+
30
30
31
31
The *Rearrange Widgets* button also allows you to delete widgets that you have inserted. To delete a widget, click *Rearrange Widgets* and you’ll see an x appear in the top-right corner of each widget. Click the ‘x’ on each widget you’d like to delete.
32
32
33
-
33
+
34
34
35
35
You can also resize widgets by clicking the grey arrows that appear at the edges of each widget when you hover over them.
36
36
37
37
Click and drag the body of the widget to move it to a different spot on the Dashboard. The widgets will fill the space as efficiently as possible. If there is a gap above one of the widgets, it will automatically move up to fill the space.
38
38
39
39
Each widget also has several settings associated with it. Click the gear icon in the top-right corner of a widget to adjust the individual settings for that widget.
40
40
41
-
41
+
42
42
43
43
When you are satisfied with the size and layout of your widgets, click the blue checkmark in the top-right of the Superdesk interface to keep these changes.
44
44
45
45
#### World Clock Widget Settings
46
46
47
-
47
+
48
48
49
49
To add a World Clock Widget, click the Create icon in the top right corner of the Dashboard pane, then select the World Clock option. Click the ADD THIS WIDGET button to confirm your choice.
50
50
51
-
51
+
52
52
53
53
The World Clock widget has customisable clocks for all time zones. Click the gear icon in the top-right corner of the widget to open the World Clock Configuration window.
54
54
55
-
55
+
56
56
57
57
The *Your Clock* tab in the World Clock Configuration Window displays the clocks that are currently used in your World Clock widget.
58
58
@@ -65,36 +65,36 @@ To add different clocks, click on the *Available Clocks* tab and scroll through
65
65
66
66
The Monitoring widget allows for an overview of the Desk and its Stages. Stages are the way in which content items are sorted and tracked within a Desk. For example, the Stages of a Desk might include an input Stage (destination for articles created in or fetched to a Desk), a working Stage (articles in progress), an editing Stage, or an output Stage (items ready to be published). Monitoring widgets can also be set up to show *Saved Searches*. Note that the general Stages of a Desk can be created and edited by users with the appropriate privileges in *Hamburger menu \> Settings \> Desks*. To add a Monitor Widget to your Dashboard, click the Create icon in the top right corner of the Dashboard pane:
67
67
68
-
68
+
69
69
70
70
To adjust the Monitoring widget settings, click the gear icon in the top-right corner of the monitoring widget. Because you can have several Monitoring widgets on the same desk at the same time, the first text box in the Monitoring settings window gives you the option to rename your Monitoring widget.
71
71
72
-
72
+
73
73
74
74
In the Monitoring settings window, under the Desks tab, you can select the Stages that you wish to view in your Monitoring widget. You can only select the Stages in Monitoring Settings associated with the current desk. (The only exception to this occurs if a Stage is marked for Global Read by an administrator in the *Hamburger Menu \> Settings \> Desks*, in the Stage options. Stages that are marked for Global Read can be added to any Monitoring window in any Desk.) If a Stage is currently empty, the Monitoring widget will not show any information from that Stage.
75
75
76
-
76
+
77
77
78
78
In addition to Stages, Monitoring widgets can also be set up to display *Saved Searches*. Searches can be saved from the Search icon in the Workspace Panel. To select which searches you’d like displayed in your Monitoring widget, click the *Saved Searches* tab in the Monitoring Settings window. Here you will see a list of *Saved Searches*. To add one to your Monitoring widget, toggle the switch beside the *Saved Search* to the blue *on* position. Only searches that are marked for Global Read will show up as options here.
79
79
80
80
When you are creating a *Saved Search* in the Search tab, and you want to use it in your Monitoring widget, make sure that you toggle the Global Read to the *on* position before you click *Save*.
81
81
82
-
82
+
83
83
84
84
You can arrange Stages and Saved Searches under the *Reorder Sections* tab of the Monitor settings window. Drag and drop the order of the Searches and Stages to arrange the order that suits your needs.
85
85
86
-
86
+
87
87
88
88
The Items Count tab in the Monitor Settings window allows you to set how many items appear in each section of the Monitoring widget. You can adjust the number of items by typing them into the text box or by clicking the up and down arrows that appear when you hover over the text box. Once you are satisfied with your Monitoring settings, click the *DONE* button at the bottom of the Monitoring Settings window.
89
89
90
90
#### Ingest Stats Widget Settings
91
91
92
92
The Ingest widget allows you to track information about the types of news items that are being ingested into your Superdesk interface. Clicking on the gear icon in the top right corner of the Ingest widget will allow you to change what information is displayed in your Ingest widget.
93
93
94
-
94
+
95
95
96
96
To add an Ingest Stats Widget to your Dashboard, click the Create icon in the top right corner of the Dashboard pane, then select the Ingest Stats option, and click ADD THIS WIDGET.
97
-
97
+
98
98
99
99
In the Ingest Stats Configuration window, select a source type from the first drop-down menu:
100
100
@@ -104,28 +104,28 @@ In the Ingest Stats Configuration window, select a source type from the first dr
104
104
105
105
In the second drop-down menu on the Ingest Stats Configuration window allows you to choose a colour scheme for your Ingest Stats graph. The choice of colour is purely cosmetic.
106
106
107
-
107
+
108
108
109
109
Once you have adjusted your Ingest widget settings to your liking, click the *SAVE* button.
110
110
111
-
111
+
112
112
113
113
The information on the Ingest Widget is presented as a graph. In the source example above, you can see that the majority of the ingested articles are coming from Forbes.
114
114
115
-
115
+
116
116
117
117
If all of the items are from the same source, urgency or item type, you will only see one colour on your graph. In the item type example above, you can see text, picture and composite items have been ingested.
118
118
119
119
#### Activity Stream Widget Settings
120
120
121
-
121
+
122
122
To add an Activity Stream Widget to your Dashboard, click the Create icon in the top right corner of the Dashboard pane, then select the Activity Stream option, and click ADD THIS WIDGET.
123
123
124
-
124
+
125
125
126
126
The Activity Stream widget allows you to stay up-to-date on progress being made on all Stages, from all users across Superdesk. The displayed Activity Stream is the same, regardless of which desk the widget is on.
127
127
128
-
128
+
129
129
130
130
By clicking the gear icon in the top-right corner of the Activity Stream widget, you can adjust the number of items that appear in your widget. In the Activity Stream Configuration window, select the number of items you wish to see, then click the *SAVE* button.
131
131
@@ -138,16 +138,16 @@ This widget is used to display the actions of a single user. The User Activity w
138
138
3) Items that have been **created** by that user.
139
139
4) Items that have been **moved** to a working stage by that user.
140
140
141
-
141
+
142
142
143
143
To add a User Activity Widget to your Dashboard, click the Create icon in the top right corner of the Dashboard pane, then select the User Activity option, and then click ADD THIS WIDGET.
144
144
145
145
Once the widget has been created on the Dashboard, you will need to select a user to monitor using the drop-down menu at the top left of the widget.
146
146
147
-
147
+
148
148
149
149
Only users who are members of the Desk are shown in the drop-down menu.
150
-
150
+
151
151
152
152
In the example of a User Activity Widget, shown above, the only activity that the above user has done is create a new item, and attach photos to it. Each uploaded photo appears as a separate entry in this case.
0 commit comments