Skip to content

Commit 1810ed6

Browse files
narcher7MartinSchoeler
authored andcommitted
DOCS: Edits to Message page (RocketChat#1420)
* DOCS: Edits and reformat for Channel Actions page * Fix build errors * DOCS: Make edits to Messages * Fix build errors * Remove links to remove build errors. Will add back in later * Fix build error * Correct typo
1 parent 351b24e commit 1810ed6

File tree

2 files changed

+51
-135
lines changed

2 files changed

+51
-135
lines changed

administrator-guides/permissions/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@ Also, by default roles are shown as little tags on the side of a username on mes
6161
| create-user | Permission to create new users. Accessible from Administration -> Users. Click the + sign found on the top right hand corner of the Users list to create a new user.
6262
| delete-c | Permission to delete public channels.
6363
| delete-d | Permission to delete direct messages.
64-
| delete-message | Permission to delete a message within a channel. See [deleting messages](../../user-guides/messaging/#deleting-messages).
64+
| delete-message | Permission to delete a message within a channel.
6565
| delete-p | Permission to delete private channels.
6666
| delete-user | Permission to delete users.
67-
| edit-message | Permission to edit a message. See [editing messages](../../user-guides/messaging/#editing-messages).
67+
| edit-message | Permission to edit a message.
6868
| edit-other-user-active-status | Permission to enable or disable other accounts. Accessible from Administration -> Users.
6969
| edit-other-user-info | Permission to change other user's name, username or email address. Accessible from Administration -> Users.
7070
| edit-other-user-password | Permission to modify other user's passwords. Requires edit-other-user-info permission. Accessible from Administration -> Users.

user-guides/messaging/README.md

Lines changed: 49 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -1,193 +1,109 @@
1-
# Messaging
1+
# Messages
22

3-
## Composing messages
3+
This page explains the ins and outs of messaging in Rocket.Chat.
44

5-
Sending messages in Rocket.Chat is self-explanatory: type a message in the message box and press <kbd>Enter</kbd> or the Send Button.
5+
## Compose messages
66

7-
If you want to send multiple lines of text, press <kbd>Shift</kbd> + <kbd>Enter</kbd> to add a new line.
7+
To compose a message in Rocket.Chat, go the channel or user you want to send a message. Type the message box and press <kbd>Enter</kbd> or the **Send** Button.
88

9-
## Cursor movement while composing a message
9+
If you want to add new lines of text, press <kbd>Shift</kbd> + <kbd>Enter</kbd> to add a new line.
1010

11-
You can move the cursor using the arrow keys while writing or editing messages. When you press the `Up Arrow` or `Down Arrow` keys, the cursor moves to the location determined by the wrapping of the text.
11+
## Cursor movement
1212

13-
### Move the cursor to the beginning or end of a message
13+
While writing or editing messages, you can move the cursor using the arrow keys. Where the cursor moves depends on the wrapping of the text.
1414

15-
Holding `Alt` or `Command` while pressing an arrow key moves to the beginning or end of the message.
15+
Hold `Alt` or `Command` while pressing the right or left arrow keys to move the cursor to the beginning or end of the message.
1616

1717
## Notify other team members
1818

19-
To get someone’s attention in a channel, type `@` followed by their username, for example `@guarilha`. (They’ll see a red badge on the channel and be notified via email or their mobile device if theyre not online)
19+
To get the attention of a specific team member in a channel, type `@` followed by their username, for example, `@username`. The mentioned user sees a red badge on the channel or is notified via email or their mobile device if they're not online.
2020

21-
You can also notify everyone in a channel by typing `@all`. But avoid using `@all` because it notifies everyone. Although `@all` is useful for important announcements, it can be distracting if abused.
21+
You can also notify everyone in a channel by typing `@all`. We recommend using `@all` sparingly. Although notifying everyone in the channel is useful for announcements, not every message requires this.
2222

23-
## Sending attachments
23+
## Send attachments
2424

25-
In Rocket.Chat you can send a variety of attachments on your message, like files, audio, links, videos, and many more.
25+
You can send a variety of attachments on your messages, like files, audio, links, videos, and many more.
2626

27-
To access the attachment menu you can simply click on the plus (+) icon on the message input.
27+
To access the attachment menu you can, click on the **plus** (+) icon on the message input.
2828

2929
### Files
3030

3131
You can select files using three methods:
3232

33-
- By selecting the `Select Files from Computer` option from the attachment menu;
34-
- By dragging and dropping the file on Rocket.Chat;
35-
- By pasting a image from the clipboard;
33+
- By choosing the **Select Files from Computer** option from the attachment menu
34+
- By dragging and dropping the file on Rocket.Chat
35+
- By pasting an image from the clipboard
3636

37-
After Selecting the file, you will be prompted to add a name and a description to it. After that just press send.
37+
After selecting the file, add a name and a description of the file and press **Send**.
3838

39-
_Be aware that the server administrator can block certain file types from being uploaded._
39+
_Remember that the server administrator can block certain file types from being uploaded._
4040

4141
### Audio
4242

43-
Before sending a audio message, if you are using a browser, you need to give Rocket.Chat permission to use your microphone.
43+
When using Rocket.Chat through a web browser give Rocket.Chat permission to use your microphone.
4444

45-
To start recording you can simply click on the `Create new Audio Message` option on the attachment menu. To stop recording just press the same option again.
46-
47-
You will have the chance to listen to the message before sending it.
45+
To start recording, click on the **Create new Audio Message** or the option in the attachment menu or the microphone inside the message box. To stop recording, click the green checkmark. The audio message automatically sends. You can choose to pay or download the message.
4846

4947
### Video
5048

51-
Before sending a video message, if you are using a browser, you need to give Rocket.Chat permission to use your camera.
49+
When using Rocket.Chat through a web browser give Rocket.Chat permission to use your webcam.
5250

53-
To start recording you can simply click on the `Create new Video Message` option on the attachment menu.
51+
To start recording, click on the **Create new Video Message** option in the attachment menu, then click the red circle icon.
5452

55-
Then click the circle icon, when the recording starts the icon will be replaced with a square "stop" icon. To end the video recording, click the "stop" icon.
53+
While recording, a stop button appears. To end the recording, press **Stop**.
5654

57-
To preview and send your last video recorded, click the "ok" button, which will display a window where you can watch and download the video, name it and give it an optional description. Click the "send" button to send the video or the "cancel" button to discard the video recording.
55+
Preview the video you recorded by pressing **Ok**. A window appears where you can watch, download, and name the video. To send the video, click **Send** or click **Cancel** to discard the video.
5856

5957
## Interacting with Google Drive
6058

61-
_Note:_ Google Drive features shall only be available if the admin has enabled Google Drive access and correctly provided the required API keys. Instructions to obtain these keys can be found in the [Administrator guides](../../administrator-guides/). Furthermore, users wishing to use this feature shall be required to give permission to Rocket.Chat to access their Google Drive account.
59+
_Note:_ Google Drive features available only if the server's admin has enabled Google Drive access and provided the correct API keys. For instructions to obtain these keys can see the [Administrator guides](../../administrator-guides/).
6260

6361
### From Google Drive to Rocket.Chat
6462

65-
Files can be uploaded from Google Drive to a room by selecting the `Select Files from Google Drive` option on the attachment menu. This opens a Google Drive file picker GUI with search, view modes and other such functionalities. Selecting the required file shall then prompt the user to enter the title and description for the upload.
63+
Files can be uploaded from Google Drive to a room by selecting the **Select Files from Google Drive** option on the attachment menu. This opens a Google Drive file picker GUI with search and view modes. Select the required file, enter a title and description, and then click **Upload**.
6664

67-
Files shall be uploaded in the same format to Rocket.Chat as they are in Google Drive, except for Google docs, slides and sheets which shall be converted to pdf format before the upload.
65+
Files upload in the same format to Rocket.Chat as they are in Google Drive with exception to Google docs, slides and sheets which convert to pdfs upon upload.
6866

6967
### From Rocket.Chat to Google Drive
7068

71-
A file uploaded as a message attachment to a room can be uploaded to Google Drive by clicking on the `Save to Google Drive` button above the attachment.
72-
73-
The format of the uploaded file shall be the same as the original message attachment.
74-
75-
### Creating Google Docs, Slides and Sheets
76-
77-
Google docs, slides and sheets can be created from Rocket.Chat by clicking on the corresponding option on the attachment menu. The file shall be created in the user's Drive account and its link posted as a message in the opened room. The sharing setting for the file shall remain default. It can be changed by the file owner via the link to collaborate with other users.
78-
79-
### Links
80-
81-
When you send a link in a message, you will get a preview of the site, and in some cases it can create a interactive attachment, like a youtube video preview or a Spotify mini player.
69+
Files uploaded as a message attached to a room can be uploaded to Google Drive. Click **Save to Google Drive** above the file attachment.
70+
The file saves to Google Drive in its original format.
8271

83-
### Location
72+
### Create Google Docs, Slides and Sheets
8473

85-
Before sharing your location if you are using a browser, you need to give Rocket.Chat permission to use your current location.
74+
Create Google docs, slides, and sheets by clicking to corresponding file type in the attachments menu. The file saves to that user's Google Drive account and posts on the message or channel from which creation occurs. The sharing setting for the file shall remain default. It can be changed by the file owner via the link to collaborate with other users.
8675

87-
To share your location, click on the option `Share My Location`, that will send a message with a map preview and a link to Google Maps on your current location.
76+
## Links
8877

89-
## Emojis
78+
URL's to other sites automatically generate a preview of that site's content. Copy and paste the link into the message box to create the preview.
9079

91-
To insert a emoji in a message, hit the emoji button on the left of the message input to view an emoji picker. There you can select by sections and search for emojis.
80+
## Location
9281

93-
You can also insert emojis by inputing a colon `:` in the message compose box followed by typing the emoji name.
82+
To share your location, click **Share My Location**. A message generates a link to a Google Map of your location.
9483

95-
For example to input the smiley face emoji start typing `:smile:`, after you have input two characters of the emoji's name a list of matched emojis will be displayed.
84+
## Emoji
9685

97-
As you input more characters from the name, the search space will narrow. You can use the `Up` and `Down` arrow keys and `Enter` to select an emoji to insert or select one by left clicking on it.
86+
To insert an emoji, click the **smiley face icon** in the message box. Browse through emoji using the icon categories or through the search box.
9887

99-
Alternatively you can type out the full emoji name, make sure to end the name with a `:`.
88+
You can also insert emojis by inputting an [emoji code](https://www.webfx.com/tools/emoji-cheat-sheet/).
10089

101-
### Emoji shortcuts
90+
### Emoticons
10291

103-
Various emoji shortcuts exists to display popular text representations as graphical emojis. For example a message with the following text `:)` will display as the graphical `:slight_smile:` emoji.
92+
Rocket.Chat changes common emoticons, or symbols used to represent emoji, to the equivalent emoji. For example, `:)` converts to the `:smiley:` emoji.
10493

10594
### Disabling emojis
10695

107-
Graphical emojis can be enabled/disabled in [Your Account](../managing-your-account/) settings under the **Messages** section.
96+
Emojis can be enabled/disabled in [Your Account](../managing-your-account/) settings under the **Messages** section.
10897

109-
When graphical emojis are disabled, emoji keywords and shortcuts will be displayed as is e.g. `:smile:` or `:)`.
98+
When graphical emojis are disabled, emoji keywords and shortcuts display as regular text.
11099

111100
## Formatting
112101

113-
To format properly your message you can wrap the text you want to augment with special characters:
114-
115-
* Bold: `*Lorem ipsum dolor*` ;
116-
* Italic: `_Lorem ipsum dolor_` ;
117-
* Strike: `~Lorem ipsum dolor~` ;
118-
* Inline code: `` `Lorem ipsum dolor` ``;
119-
* Image: `![Alt text](https://rocket.chat/favicon.ico)` ;
120-
* Link: `[Lorem ipsum dolor](https://www.rocket.chat/)` or `<https://www.rocket.chat/ |Lorem ipsum dolor>` ;
121-
122-
## Message Actions
123-
124-
You can interact with already posted messages too. To open the message actions menu, hover your mouse over the desired message, click on the three dots that will appear on the right side of the message.
125-
126-
### Editing messages
127-
128-
To edit a message, click on the `edit` option on the message actions menu. Alternatively, in the message input box, press the `Up Arrow` to edit the last message sent.
129-
130-
_The administrator of a Rocket.Chat team sets the permissions for who can edit messages from other users. By default, only administrators, moderators, and owners of the channels can edit messages from other users._
131-
132-
#### Switching messages to edit
133-
134-
While editing, if the cursor is at the **beginning** of a message, pressing the `Up Arrow` switches to editing the **previous** message you wrote.
135-
136-
Similarly, if the cursor is at the **end** of a message, pressing the `Down Arrow` switches to editing the **next** message you wrote.
137-
138-
#### Drafting messages
139-
140-
Rocket.Chat saves drafts of edits to your messages. That way, you can return to an edit draft after switching to another message. Pressing `ESCAPE` discards an edit draft.
141-
142-
#### Deleting messages
143-
144-
You can delete a message by clicking on `delete` option on the message actions menu.
145-
146-
You can also delete a message by emptying the contents while editing and saving your changes. You will be asked to confirm the message deletion and warned that the message contents will be able to be recovered.
147-
148-
### Starring messages
149-
150-
Starring a message makes it easy to find it later. To star a message, select the `star-message` option on the message actions menu, to un-star it just select the `unstar` option on the message actions menu.
151-
152-
You can find your starred messages on the starred messages tab. <!-- TODO: add link to starred message tab -->
153-
154-
Starred messages are per chat room and are not global, each room has its own list of messages you have starred in that channel.
155-
156-
### Pinning messages
157-
158-
Pinning a message to a channel causes the message to be easily accessible via pinned messages tab. <!-- TODO: add link to pinned message tab --> To pin a message, select the `pin-message` option on the message actions menu, to un-pin it just select the `unpin` option on the message actions menu.
159-
160-
_The administrator of a Rocket.Chat team sets the permissions for who can pin messages in a channel. By default, only administrators, moderators, and owners of the channel can pin messages ._
161-
162-
### Reactions
163-
164-
You can quickly respond to any message with an emoji reaction. Reactions can be used for any purpose including voting, checking off to-do items, showing excitement, answering questions or just for fun.
165-
166-
To add reaction to a message, hover your mouse over it, and click on the smiling face icon on the right of the message
167-
and choose an emoji.
168-
169-
To remove an emoji reaction, click on the emoji below the message. To reiterate an existing emoji reaction that someone else posted, click on that emoji to add to that emoji's counter.
170-
171-
### Permalinking a message
172-
173-
Permalinking a message creates a link directing to that message, also if you post a permalink on another channel it creates a preview with the contents of the message.
174-
175-
To permalink a message simply click on the `permalink` option on the message actions menu and the link will be copied to your clipboard.
176-
177-
### Copying a message
178-
179-
To copy the contents of a message to your clipboard, simply click on the `copy` option on the message actions menu.
180-
181-
### Replying to a message
182-
183-
Replying to a message will create a attachment showing the message you wish to reply after the sent text.
184-
185-
Replying to a message will trigger a notification to the replied message sender by using an `@` mention.
186-
187-
To reply to a message, click on the `reply` option on the message actions menu and write your message after the link that was inserted on the message input.
188-
189-
Replying to a already replied message will create a string of messages, showing every message quoted before the current one.
190-
191-
### Quoting a message
102+
Use the following symbols to format text as desired:
192103

193-
Quoting is very similar to replying, the only diference being that the quoted message sender will not be notified.
104+
* Bold: `*Lorem ipsum dolor*`
105+
* Italic: `_Lorem ipsum dolor_`
106+
* Strike: `~Lorem ipsum dolor~`
107+
* Inline code: `` `Lorem ipsum dolor` ``
108+
* Image: `![Alt text](https://rocket.chat/favicon.ico)`
109+
* Link: `[Lorem ipsum dolor](https://www.rocket.chat/)` or `<https://www.rocket.chat/ |Lorem ipsum dolor>`

0 commit comments

Comments
 (0)