Skip to content

Commit 351b24e

Browse files
narcher7MartinSchoeler
authored andcommitted
DOCS: Edit and reformat for Channel Actions page (RocketChat#1415)
* DOCS: Edits and reformat for Channel Actions page * Fix build errors
1 parent 3ac4302 commit 351b24e

File tree

1 file changed

+65
-66
lines changed

1 file changed

+65
-66
lines changed
Lines changed: 65 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,73 @@
11
# Channel Actions
22

3-
With channels you can also do more than merely post messages and upload files, you can interact in various ways through the channel actions menu. Channel actions are located to the right of the channel title. Some of the menus are accessible by clicking on the three dots at the end of the channel header.
3+
Inside channels, you can also do more than post messages and upload files. Increase your interaction with messages through Channel actions.
4+
5+
## Find channel actions
6+
7+
To find channel actions, go to the right of the channel title and click the menu.
48

59
_Channel actions vary depending on the server configuration, so the items listed below might not all be visible in your installation._
610

7-
## Favorites
11+
## Favorite
812

913
To help organize and prioritize your communications, you can **favorite** (or **star**) channels, private groups, and DMs.
1014

11-
To favorite a channel, click on the star icon to the left of the channel header (next to the room name).
15+
To favorite a channel, click the **star** icon to the left of the channel header.
1216

13-
Favoriting a channel moves it to a "Favorites" section on the channels list, making it easier to access and find.
17+
Favoriting a channel moves it to a **Favorites** section on the channels list, making it easier to access and find.
1418

1519
## Channel Info
1620

17-
Here you can see all kinds of information about the current channel. If you have the proper permissions, this information can be edited. These are the channel info options:
21+
Here you can see all kinds of information about the current channel. If you admin permissions, you can edit this information. These are the channel info options:
1822

1923
- __Channel Name__: The name of the channel, how users see the title and find the channel via search.
2024

21-
- __Topic__: The topic shows next to the title on the channel header. Great for giving more info on what the channel is about.
25+
- __Topic__: The topic shows next to the title on the channel header. Great for giving more info about the channel.
2226

23-
- __Announcement__: The announcement is shown in a very visible bar under the channel header.
27+
- __Announcement__: Announcements post in a bar under the channel header.
2428

2529
- __Description__: The description of the channel.
2630

2731
- __Private__: Tells whether a channel is private, and can set the channel to private or public.
2832

29-
- __Read Only__: Tells whether a channel is read only, and toggles the read only status on the channel. In read only channels, messages can only be posted by people with the right permission. Good for announcements channels and such.
33+
- __Read Only__: Tells whether a channel is read-only, and toggles the read-only status on the channel. In read-only channels, only people with admin permissions can post messages. Good for announcements channels.
3034

3135
- __Archived__: Tells if a channel is archived, and toggles the archived status of a channel. Nobody can post messages in an archived channel, and channel search will not find that channel.
3236

3337
- __Password__: Tells whether a channel has a password and let you set the password. If a channel has a password, other users need to enter the password to become a member of the channel.
3438

35-
If a [retention policy](../../administrator-guides/retention-policies/) is active on this channel, a red warning box will appear saying when your messages or files will be automatically deleted.
39+
If a [retention policy](../../administrator-guides/retention-policies/) is active on this channel, a red warning box appears saying when messages or files are deleted.
3640

3741
## Search Messages
3842

3943
Rocket Chat search supports basic search commands which work like Gmail search.
4044

41-
Rocket Chat also supports the use of "[regular expressions](https://en.wikipedia.org/wiki/Regular_expression)". The benefits of regular expressions are great search flexibility and the ability to search chat entries in any language, even ones which are traditionally a challenge to search (like "CJK" languages - Chinese, Japanese, Korean).
45+
Rocket Chat also supports the use of "[regular expressions](https://en.wikipedia.org/wiki/Regular_expression)." Regular expressions provide flexibility and the ability to search chat entries in any language, even ones which are traditionally a challenge like "CJK" languages (Chinese, Japanese, Korean).
4246

4347
### Basic Search Commands
4448

4549
You can use these commands before or after entering search terms:
4650

47-
`from:me` to search for messages only created by the current user.
51+
- `from:me` to search for messages only created by the current user.
4852

49-
`from:user.name` to search for messages created by a specific user. The username entered must be the format without spaces (i.e. "john.doe" and not "John Doe". To search for any time a user was mentioned, just search for their username.
53+
- `from:user.name` to search for messages created by a specific user. The username entered must be the format without spaces (i.e., "john.doe" and not "John Doe.") Search for any mentions of a user by searching for their username.
5054

51-
`has:star` returns messages that are starred by the current user.
55+
- `has:star` returns messages that are starred by the current user.
5256

53-
`is:pinned` or `has:pin` returns messages that are pinned in the current channel.
57+
- `is:pinned` or `has:pin` returns messages that pin in the current channel.
5458

55-
`has:url` or `has:link` returns messages that contain a link.
59+
- `has:url` or `has:link` returns messages that contain a link.
5660

57-
`has:location` or `has:map` returns messages that have a location attached.
61+
- `has:location` or `has:map` returns messages that have a location attached.
5862

59-
`before:dd/mm/yyyy`, `after:dd/mm/yyyy` and `on:dd/mm/yyyy` return message that were created before, after, or on the provided date.
60-
Dashes `dd-mm-yyyy` or dots `dd.mm.yyyy` can be used instead of slashes.
63+
- `before:dd/mm/yyyy`, `after:dd/mm/yyyy` and `on:dd/mm/yyyy` return message that were created before, after, or on the provided date.
6164

65+
Dashes `dd-mm-yyyy` or dots `dd.mm.yyyy` can be used instead of slashes.
6266
`order:asc`, `order:ascend`, or `order:ascending` sorts messages by ascending timestamp.
6367

64-
`order:desc`, `order:descend`, or `order:descending` sorts messages by descending timestamp.
68+
- `order:desc`, `order:descend`, or `order:descending` sorts messages by descending timestamp.
6569

66-
You can also jump to where a message is located by hovering the mouse over the search result and selecting `jump to message`.
70+
You can also jump to where a message is located by hovering the mouse over the search result and selecting `jump to message.`
6771

6872
### Regex
6973

@@ -76,22 +80,22 @@ These references tell more about the powerful world of regex:
7680

7781
## Members List
7882

79-
Here you can see all the users on channel and see more information about them. If you have the proper permission, you can manage them on your channel.
83+
Here you can see all the users on the channel and see more information about them. If you have the proper permission, you can manage them on your channel.
8084

81-
At first, only the current active users are shown. To see all users, click the `show all` link.
85+
At first, the list only shows currently active users. To see all users, click the **show all**.
8286

8387
To see more information on a user, click their name on the list.
8488

8589
The user preview screen shows their name, username, any role tags they might have, and their current timezone.
86-
From there you can also:
90+
From there, you can:
8791

8892
- Start a direct conversation with the user by clicking the `conversation` option
8993

9094
- Start a video call with the user
9195

9296
- Set the user as channel owner
9397

94-
- Set the user as channel moderator
98+
- Set the user as a channel's moderator
9599

96100
- Mute the user
97101

@@ -103,80 +107,75 @@ You can change the behavior of notifications for channels where you are a member
103107

104108
These options are on the channel notifications tab:
105109

106-
- __Disable Notifications__: disable all notifications for the channel.
107-
108-
- __Audio__: select whether the channel will emit a sound whenever someone mentions you or posts a message in that channel. The sound to play can be specified.
109-
110-
- __Desktop__: controls notification behavior when using any desktop app or browser.
111-
112-
- __Mobile__: controls push notification behavior when using any mobile app.
110+
- __Disable Notifications__: Disable all notifications for the channel.
113111

114-
- __Email__: set whether email is sent whenever someone mentions you or posts a message, or disable email notifications.
112+
- __Audio__: Select whether the channel will emit a sound whenever someone mentions you or posts a message in that channel. The sound played can be customized.
115113

116-
- __Unread Room Status__: Controls whether the channel on the channel list is highlighted when there is a new message or mention.
114+
- __Desktop__: Controls notification behavior when using any desktop app or browser.
117115

118-
- __Unread Tray Icon__: Controls whether the tray icon is highlighted when there are new messages or mentions on the current channel.
116+
- __Mobile__: Controls push notification behavior when using any mobile app.
119117

120-
## Files List
118+
- __Email__: Set whether an email sends whenever someone mentions you or posts a message, or disable email notifications.
121119

122-
A list of all the files uploaded to the current channel.
120+
- __Unread Room Status__: Control whether the channel on the channel list highlights when there is a new message or mention.
123121

124-
## Mentions
122+
- __Unread Tray Icon__: Controls whether the tray icon highlights when there are new messages or mentions on the current channel.
125123

126-
All messages which mentioned you in the current channel.
124+
## Message list options
127125

128-
## Starred Messages
126+
This section details a list of all different types of lists specific to channels:
129127

130-
All messages which you have starred in the current channel.
128+
- __Files List__: A list of all the files uploaded to the current channel.
131129

132-
## Pinned Messages
130+
- __Mentions__: All messages that mentioned you on the current channel.
133131

134-
All messages that were pinned on the current channel.
132+
- __Starred Messages__: All messages that you have starred in the current channel.
135133

136-
## OTR
134+
- __Pinned Messages__: All messages pinned to the current channel.
137135

138-
OTR stands for __Off The Record__ Messaging.
136+
## Streaming
139137

140-
OTR is basically end to end encrypted conversations.
138+
If the feature [Youtube Livestream](../../administrator-guides/youtube-broadcasting) is enabled, the **Streaming** Tab activates on the channel actions menu.
141139

142-
You can only use OTR in direct messages (one-on-one) and both sides must be online.
140+
Through the **Streaming** tab, owners of the channel of server admins can start streaming or add another stream to the channel using a URL.
143141

144-
To start OTR conversation, click on _START OTR_. The other user will be notified to start a OTR.
142+
### Start a stream
145143

146-
After your request is confirmed by other side, messages are encrypted. Encrypted messages have a key icon on the right side.
144+
_Note: Depending on the settings of the server, you might be only able to link live streams from Youtube. In doubt always ask your server's admin._
147145

148-
## Streaming
146+
1. Press the **Broadcast my Camera** button.
147+
2. Login with a Google account. Remember that streaming must be activated through your Youtube account. For more information, see [Introduction to live streaming](https://support.google.com/youtube/answer/2474026?hl=en) Google guide).
149148

150-
If the feature [Youtube Livestream](../../administrator-guides/youtube-broadcasting) is enabled, you will see the `Streaming` Tab on the channel actions menu.
149+
To add a different Livestream, get the URL (must be from Youtube) for the stream, enter it into the **Livestream source** field and hit save.
151150

152-
If you are the owner of the channel or if you are a admin server you will be able to start streaming from there, or add a current ongoing stream to the channel via url.
151+
You can also add a message for whenever the stream is unavailable in the **Livestream not available message** field.
153152

154-
_Note: depending on the settings of the server you might be only able to link live streams from Youtube. In doubt always ask your server's admin._
153+
To add a stream with no video and only audio, use the **Enable audio only button**.
155154

156-
To start streaming from rocket.chat just press the `Broadcast my Camera` button. After that you will be prompted to login with a google account (you need to have streaming activated on your youtube account before, see [Introduction to live streaming](https://support.google.com/youtube/answer/2474026?hl=en) Google guide).
155+
### (Users) Start a Live Stream
157156

158-
You can also add a stream from Youtube with the stream link (The owner of the stream must allow the stream to be shown in other sites). To start a live stream from youtube, just add the link to it on the `Livestream source` form and hit save.
157+
If you are not a channel owner and there is already a live stream set to that channel, press **play** on the stream tab. This starts a pop-up with the stream embedded. The pop-up does not close even if you change channels.
159158

160-
You can add a message to whenever the stream is unavailable in the `Livestream not available message` field.
159+
## Prune Messages
161160

162-
You can also stream only the sound of the live stream with the `Enable audio only button`. This is very useful when you want to do a podcast for example.
161+
If you are a server admin, or your admin has given you the **clean-channel-history** permission, the **prune messages** option allows you to delete messages from a channel swiftly.
163162

164-
If you are not a channel owner and there is already a live stream set to that channel, you will need only press play on the stream tab. Doing that will create a pop over embedded video, that can be moved around the screen and even if you change channels you will still be able to watch that stream, since the popover will not close when changing channels.
163+
_Note: Messages and files deleted with this option are deleted forever and cannot be recovered. Be careful and double-check your arguments before pressing Prune._
165164

166-
## Prune Messages
165+
Use the following parameters to delete specific messages:
167166

168-
If you are a server admin, or your admin has given you the `clean-channel-history` permission (for example, an admin may give that permission to channel owners), this option will allow you to swiftly delete messages from a channel.
167+
- `Newer than`: Deletes all messages posted **after** a particular date.
169168

170-
`Newer than` and `Older than` allow you to set a timespan of messages to delete. If you leave both fields blank, all messages will delete. If you only wish to delete all messages posted after a specific date, you can fill in the `Newer than` field. If you wish to delete all messages posted before a specific date, you can fill in the `Older than` field. To delete messages between two dates, you fill in both fields.
169+
- `Older than`: Deletes all messages posted **before** a particular date.
171170

172-
The `Users` field allows you to specify any users to delete the content from. If this field is filled, only their messages will be cleared. Leave it empty to not narrow down - the script will not care about who the content belongs to.
171+
Fill dates for both the `Newer than` and `Older than` fields to delete all messages.
173172

174-
To further specify what you wish to be removed, you can use the other checkboxes:
173+
- `Users`: Allows you to specify any users to delete the content. When filled with a username, that user's messages deleted.
175174

176-
- __Inclusive__: if this is checked, all messages that land on the exact start/end times you have specified will be deleted too.
175+
Refine the parameters above with the following options. Check each to enable:
177176

178-
- __Exclude pinned messages__: if this is checked, it will NOT delete pinned messages.
177+
- __Inclusive__: Deletes all messages that land on the exact start/end times you have specified in the `Newer than` and `Older than` fields.
179178

180-
- __Only remove the attached files, keep messages__: if this is checked, this will only remove files, not the messages themselves.
179+
- __Exclude pinned messages__: Do **not** delete pinned messages.
181180

182-
_Messages and files deleted with this option are deleted forever and cannot be recovered. Be careful and double-check your arguments before pressing Prune._
181+
- __Only remove the attached files, keep messages__: Removes files but not the messages themselves

0 commit comments

Comments
 (0)