From faa068098ed3f25cffc625e4a343e17cb6278028 Mon Sep 17 00:00:00 2001 From: John Spurlock Date: Tue, 9 Nov 2021 18:23:05 -0600 Subject: [PATCH 1/2] Jabber -> XMPP plus a few typos --- proposal-docs/social/social.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/proposal-docs/social/social.md b/proposal-docs/social/social.md index a23fd88..e54a2fb 100644 --- a/proposal-docs/social/social.md +++ b/proposal-docs/social/social.md @@ -6,7 +6,7 @@ ## Purpose -Social networks (Facebook, Instagram, Twitter, Mastodon…) and discussion platforms (Slack, Discord, Jabber, IRC, Matrix…) are a convenient way +Social networks (Facebook, Instagram, Twitter, Mastodon…) and discussion platforms (Slack, Discord, XMPP/Jabber, IRC, Matrix…) are a convenient way for podcasters to interact with their audience, and for listeners to interact with podcasters. Thanks to them listeners can comment, share or like podcast episodes. The purpose of this specification is to allow podcast apps to know where they should guide the listeners to make these interactions - and the onboarding process @@ -22,27 +22,27 @@ There are three elements: ### Social Element -- **\**[one or more "podcast:socialPlatform" elements]**\** +- **\**[one or more "podcast:socialSignUp" elements]**\** Channel (optional | multiple) - This element allows a podcaster to specify one or many platform where listeners can interact. + This element allows a podcaster to specify one or more platforsm where listeners can interact. There may be several occurences of this tag for the same element (on several platforms, the podcast may have several accounts on the same plaforms…) - - `platform` (required): This is the platform id. It can be on of the following: + - `platform` (required): This is the platform id. It can be one of the following: - activitypub - facebook - twitter - instagram - slack - discord - - jabber + - xmpp - irc - matrix - … - `podcastAccountId` (required): The podcast ID on this platform. - `podcastAccountUrl` (required): The podcast URL on this platform. - - `priority` (optional): This platform priority (useful if the podcaster wants to tell which platform is prefered, lower is better) + - `priority` (optional): This platform priority (useful if the podcaster wants to tell which platform is preferred, lower is better) Examples: - `` @@ -54,11 +54,11 @@ There are three elements: podcast:social (optional | multiple) - This element allows to make easy onboarding for listeners on social/discussion platforms, especially for decentralized ones (such as Matrix or ActivityPub) where podcasters and listeners can register on different servers. + This element allows easy onboarding for listeners on social/discussion platforms, especially for decentralized ones (such as Matrix or ActivityPub) where podcasters and listeners can register on different servers. - `homeUrl` (required): The platform home URL. - `signUpUrl` (required): The platform sign up URL. - - `priority` (optional): This platform priority (useful if the podcaster wants to tell which platform is prefered, lower is better) + - `priority` (optional): This platform priority (useful if the podcaster wants to tell which platform is preferred, lower is better) Examples: - `` @@ -72,20 +72,20 @@ There are three elements: This element allows listeners to interact (comment, share, like…) with an episode. - - `platform` (required): This is the platform id. It can be on of the following: + - `platform` (required): This is the platform id. It can be one of the following: - activitypub - facebook - twitter - instagram - slack - discord - - jabber + - xmpp - irc - matrix - … - `podcastAccountId` (required): The podcast ID on this platform. - - `pubDate` (optional): publication date on this platform. This can be useful when there are several interactions for the same plateform for the same episode (for instance , two Tweets about the same episode). Format must be ISO 8601. - - `priority` (optional): This platform priority (useful if the podcaster wants to tell which platform is prefered, lower is better) + - `pubDate` (optional): publication date on this platform. This can be useful when there are several interactions for the same platform for the same episode (for instance, two Tweets about the same episode). Format must be [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). + - `priority` (optional): This platform priority (useful if the podcaster wants to tell which platform is preferred, lower is better) - element's content: URL to this episode on this platform Examples: @@ -95,7 +95,7 @@ There are three elements: ``` - + Les Poésies d’Héloïse From 48f7b1509f2acac3271f754d29120c88fb2787f0 Mon Sep 17 00:00:00 2001 From: John Spurlock Date: Tue, 9 Nov 2021 18:27:17 -0600 Subject: [PATCH 2/2] Fix introduced typo --- proposal-docs/social/social.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposal-docs/social/social.md b/proposal-docs/social/social.md index e54a2fb..cfde4b0 100644 --- a/proposal-docs/social/social.md +++ b/proposal-docs/social/social.md @@ -26,7 +26,7 @@ There are three elements: Channel (optional | multiple) - This element allows a podcaster to specify one or more platforsm where listeners can interact. + This element allows a podcaster to specify one or more platforms where listeners can interact. There may be several occurences of this tag for the same element (on several platforms, the podcast may have several accounts on the same plaforms…) - `platform` (required): This is the platform id. It can be one of the following: