diff --git a/api_docs/changelog.md b/api_docs/changelog.md index d09f7c47c7..7c72e426f5 100644 --- a/api_docs/changelog.md +++ b/api_docs/changelog.md @@ -20,6 +20,12 @@ format used by the Zulip server that they are interacting with. ## Changes in Zulip 10.0 +**Feature level 319** + +* [Markdown message + formatting](/api/message-formatting#links-to-channels-topics-and-messages): Added + new `message-link` format for special direct links to messages. + **Feature level 318** * [`POST /register`](/api/register-queue): Updated diff --git a/api_docs/message-formatting.md b/api_docs/message-formatting.md index 2f0cbad79e..bb5290435e 100644 --- a/api_docs/message-formatting.md +++ b/api_docs/message-formatting.md @@ -23,6 +23,42 @@ for syntax highlighting. This field is used in the mentions][help-global-time] to supported Markdown message formatting features. +## Links to channels, topics, and messages + +Zulip's markup supports special readable Markdown syntax for [linking +to channels, topics, and messages](/help/link-to-a-message-or-conversation). + +Sample HTML formats are as follows: +``` html + + + #announce + + + + + #announce > Zulip updates + + + + + #announce > Zulip updates @ 💬 + +``` + +The older stream/topic elements include a `data-stream-id`, which +historically was used in order to display the current channel name if +the channel had been renamed. That field is **deprecated**, because +displaying an updated value for the most common forms of this syntax +requires parsing the URL to get the topic to use anyway. + +**Changes**: In Zulip 10.0 (feature level 319), added Markdown syntax +for linking to a specific message in a conversation. Declared the +`data-stream-id` field to be deprecated as detailed above. + ## Image previews When a Zulip message is sent linking to an uploaded image, Zulip will diff --git a/version.py b/version.py index 7825a2ee4b..185898b379 100644 --- a/version.py +++ b/version.py @@ -34,7 +34,7 @@ DESKTOP_WARNING_VERSION = "5.9.3" # new level means in api_docs/changelog.md, as well as "**Changes**" # entries in the endpoint's documentation in `zulip.yaml`. -API_FEATURE_LEVEL = 318 # Last bumped for `WebhookConfigOption` configuration update in realm_incoming_webhook_bots. +API_FEATURE_LEVEL = 319 # Last bumped for message-link class # Bump the minor PROVISION_VERSION to indicate that folks should provision # only when going from an old version of the code to a newer version. Bump