diff --git a/docs/1.0.md b/docs/1.0.md index a590fd0..246d188 100644 --- a/docs/1.0.md +++ b/docs/1.0.md @@ -1609,3 +1609,75 @@ from ``. ``` + + + +



+## Chat +``

+This element allows a podcaster to attach information to either the `channel`, `item` or `` about +where the "official" chat for either the podcast or a specific episode or live event is to be found. Just like +`` functions for social media, the `chat` tag will function for ephemeral chat. There are +many protocols in use across the internet for chat based communication. This tag is meant to be flexible enough to +adapt to whichever protocol the podcaster wants to use. + +This element's presence at a particular level governs how it should be treated. If found at the `item` or +`` level, this should be treated as the information for that specific episode, overriding what is +at the `channel` level. If this tag is found at the `channel` level, it would be considered the chat for the entire +podcast and is recommended to be an "always on" chat room experience. + +If a podcast has an "always on" style chat service it is recommended to link that at the `channel` level and do not +use the `` tag at the `item` or `` level. + +### Parent +  `` or `` or `` + +### Count +  Single + +### Attributes +- `server` (required) The fqdn of a chat server that serves as the "bootstrap" server to connect to. +- `protocol` (required) The [protocol](chatprotocols.txt) in use on the server. +- `accountId` (recommended) The account id of the podcaster on the server or platform being connected to. +- `space` (optional) Some chat systems have a notion of a chat "space" or "room" or "topic". This attribute will serve + that purpose. + +### Example (IRC): +```xml + +``` + +### Example (XMPP): +```xml + +``` + +### Example (Nostr): +```xml + +``` + +### Example (Matrix): +```xml + +``` \ No newline at end of file diff --git a/docs/chatprotocols.txt b/docs/chatprotocols.txt new file mode 100644 index 0000000..fb3f8ec --- /dev/null +++ b/docs/chatprotocols.txt @@ -0,0 +1,4 @@ +irc +xmpp +nostr +matrix \ No newline at end of file