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

56 lines
2.0 KiB
Markdown
Raw Normal View History

api-docs: Add article about markup message formatting. Adds a "Message formatting" article to the API documentation. To start, the article is a changelog of updates to markup features for messages, with the idea being that it can be expanded to further describe and document Zulip's markup features in future iterations.
2024-04-03 20:37:14 +02:00
# Message formatting
Zulip supports an extended version of Markdown for messages, as well as
some HTML level special behavior. The Zulip help center article on [message
formatting](/help/format-your-message-using-markdown) is the primary
documentation for Zulip's markup features. This article is currently a
changelog for updates to these features.
The [render a message](/api/render-message) endpoint can be used to get
the current HTML version of any Markdown syntax for message content.
## Code blocks
**Changes**: As of Zulip 4.0 (feature level 33), [code blocks][help-code]
can have a `data-code-language` attribute attached to the outer HTML
`div` element, which records the programming language that was selected
for syntax highlighting. This field is used in the
[playgrounds][help-playgrounds] feature for code blocks.
## Global times
**Changes**: In Zulip 3.0 (feature level 8), added [global time
mentions][help-global-time] to supported Markdown message formatting
features.
mentions: Add "channel" as a wildcard mention. Adds "channel" to the `stream_wildcards` frozenset for stream wildcard notifications on the backend/server. Updates frontend/web-app to handle "channel" as the other stream wildcards are handled in the typeahead and composebox modules. Updates the API version and documentation for the addition of "channel" as a wildcard mention. But does not change any of the functionailty of (or deprecate) the "stream" wildcard at this point. Part of project to rename "stream" to "channel".
2024-03-13 19:19:24 +01:00
## Mentions
**Changes**: In Zulip 9.0 (feature level 247), `channel` was added
to the supported [wildcard][help-mention-all] options used in the
[mentions][help-mentions] Markdown message formatting feature.
api-docs: Add article about markup message formatting. Adds a "Message formatting" article to the API documentation. To start, the article is a changelog of updates to markup features for messages, with the idea being that it can be expanded to further describe and document Zulip's markup features in future iterations.
2024-04-03 20:37:14 +02:00
## Spoilers
**Changes**: In Zulip 3.0 (feature level 15), added
[spoilers][help-spoilers] to supported Markdown message formatting
features.
## Removed features
**Changes**: In Zulip 4.0 (feature level 24), the rarely used `!avatar()`
and `!gravatar()` markup syntax, which was never documented and had an
inconsistent syntax, were removed.
## Related articles
* [Markdown formatting](/help/format-your-message-using-markdown)
* [Send a message](/api/send-message)
* [Render a message](/api/render-message)
[help-code]: /help/code-blocks
[help-playgrounds]: /help/code-blocks#code-playgrounds
[help-spoilers]: /help/spoilers
[help-global-time]: /help/global-times
mentions: Add "channel" as a wildcard mention. Adds "channel" to the `stream_wildcards` frozenset for stream wildcard notifications on the backend/server. Updates frontend/web-app to handle "channel" as the other stream wildcards are handled in the typeahead and composebox modules. Updates the API version and documentation for the addition of "channel" as a wildcard mention. But does not change any of the functionailty of (or deprecate) the "stream" wildcard at this point. Part of project to rename "stream" to "channel".
2024-03-13 19:19:24 +01:00
[help-mentions]: /help/mention-a-user-or-group
api-docs: Update descriptive uses of "stream" for channel rename. Updates `.md` files in api_docs/ to use "stream" instead of "channel" for descriptive text, with the exception of the API changelog file. Part of stream to channel rename project.
2024-05-14 21:04:46 +02:00
[help-mention-all]: /help/mention-a-user-or-group#mention-everyone-on-a-channel