Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

help_center: Add Markdown auto-link details link doc page. 

Adds a section about the Markdown feature to auto-link to
existing streams and topics in a Zulip message.

Also, does a little reformatting of existing text/tabs and
adds a related links section to the page.

Fixes #21085.

Co-authored-by: Alya Abbott <alya@zulip.com>
This commit is contained in:
Lauryn Menard 2022-02-17 13:11:45 +01:00 committed by Tim Abbott
parent 8e1f62af89
commit ae8ab1d831
2 changed files with 47 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
templates/zerver/help/format-your-message-using-markdown.md
View File

@ -62,10 +62,12 @@ Numbered lists
## Links
Zulip auto-linkifies URLs and valid stream names. You can also add a
[custom linkifier](/help/add-a-custom-linkifier) to link
Zulip auto-linkifies URLs and [valid stream (and topic) names][link-to-conversation].
You can also add a [custom linkifier](/help/add-a-custom-linkifier) to link
patterns like `#1234` to your ticketing system.
[link-to-conversation]: /help/link-to-a-message-or-conversation
```
Auto-detected URL: zulip.com
Named link: [Zulip homepage](zulip.com)

53
templates/zerver/help/link-to-a-message-or-conversation.md
View File

@ -1,10 +1,38 @@
# Link to a message or conversation
Share permanent links to messages, threads, and streams. With Zulip,
it's easy to to link to specific (parts of) conversations from issue
trackers, documentation, or other external tools.
Zulip makes it easy to share links to messages, topics, and streams. You can
link from one Zulip conversation to another, or share links to Zulip conversations
in issue trackers, emails, or other external tools.
## Link to a stream or topic
## Link to a stream or topic within Zulip
Zulip automatically creates links to streams and topics in messages you send.
The easiest way to link to a stream or topic is:
{start_tabs}
1. Type `#` followed by the one or more letters of the stream name.
2. Choose the desired stream from the auto-complete menu. The link will be
automatically formatted for you.
3. If linking to a topic, type `>` after selecting a stream as described above,
followed by one or more letters of the topic name.
4. Choose the desired topic from the auto-complete menu. The link will be
automatically formatted for you.
{end_tabs}
Alternately, it is possible to manually format stream and topic links:
```
Stream: #**stream name**
Topic: #**stream name>topic name**
```
## Link to a stream or topic from anywhere
{start_tabs}
@ -21,6 +49,13 @@ trackers, documentation, or other external tools.
## Link to a specific message
This will copy to your clipboard a permanent link to the message,
displayed in its thread (i.e. topic view for messages in a stream).
Viewing a topic via a message link will never mark messages as read.
Zulip uses the same permanent link syntax when [quoting a
message](/help/quote-and-reply).
{start_tabs}
{!message-actions-menu.md!}
@ -29,10 +64,8 @@ trackers, documentation, or other external tools.
{end_tabs}
This will copy to your clipboard a permanent link to the message,
displayed in its thread (i.e. topic view for messages in a stream).
## Related articles
Viewing a thread via a message link will never mark messages as read.
Zulip uses the same permanent link syntax when [quoting a
message](/help/quote-and-reply).
* [Add a custom linkifier](/help/add-a-custom-linkifier)
* [Format your messages using Markdown](/help/format-your-message-using-markdown)
* [Linking to Zulip](/help/linking-to-zulip)