From f14f7675894c391c3a39238b15f6083160de17aa Mon Sep 17 00:00:00 2001 From: Benjamin Bellamy Date: Tue, 31 Aug 2021 17:16:54 +0200 Subject: [PATCH 1/6] Update recommendations.md --- .../recommendations/recommendations.md | 33 +++++++++---------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/proposal-docs/recommendations/recommendations.md b/proposal-docs/recommendations/recommendations.md index 528dab6..7766ef8 100644 --- a/proposal-docs/recommendations/recommendations.md +++ b/proposal-docs/recommendations/recommendations.md @@ -1,6 +1,6 @@ # The "podcast:recommendations" Specification -Version 1.2 by Benjamin Bellamy - 2021.08.31 +Version 1.0 by Benjamin Bellamy - 2021.08.31
@@ -11,11 +11,10 @@ That comes with a huge drawback: finding and being found can be harsh. Podcast creators struggle to be found while podcast listeners struggle to find content. Several platforms are now implementing recommendation engines, but these features are expensive and unattainable for small players. Moreover they are slowly creating closed silos and removing power from content creators. This specification is about giving control to content creators on the content they want to recommend, and at the same time providing a free recommendation system to all players. -- Version 1.1 adds: +- Adding: - `GUID` support for channel element, - a `motive` tag that explains why a specific recommendation was included, - a `medium` tag so that this can work with any feed, including non-podcast medium. (See \ for more information.) -- Version 1.2 brings minor corrections. All this was heavily inspired by all the work previously done by the Fellowship of the PodcastIndex on the chapters and soundbite tags. May they be thanked for it. GO PODCASTING!!! @@ -73,7 +72,7 @@ The "recommendation" object takes this basic form: ```json { - "link-type": "generic", + "linkType": "generic", "title": "History of podcasting", "image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png", "url": "https://en.wikipedia.org/wiki/History_of_podcasting" @@ -82,7 +81,7 @@ The "recommendation" object takes this basic form: There are 4 required attributes: - - `link-type` (required - string) The link type of this recommended content, it can be: + - `linkType` (required - string) The link type of this recommended content, it can be: - 'generic', - 'feed', - 'feed-item', @@ -125,17 +124,17 @@ Here is what a very basic recommendations file may look like: ```json { - "version": "1.2", + "version": "1.0", "recommendations": [ { - "link-type": "none", + "linkType": "none", "medium": "text", "title": "Eat five vegetables every day.", "motive": "advertising" }, { - "link-type": "generic", + "linkType": "generic", "medium": "html", "title": "History of podcasting", "image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png", @@ -143,7 +142,7 @@ Here is what a very basic recommendations file may look like: "motive": "additional content" }, { - "link-type": "feed", + "linkType": "feed", "medium": "podcast", "title": "Podcasting 2.0", "image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg", @@ -152,7 +151,7 @@ Here is what a very basic recommendations file may look like: "motive": "audience exchange" }, { - "link-type": "item", + "linkType": "item", "medium": "podcast", "title": "Episode 26: Manning Battlestations", "image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg", @@ -161,7 +160,7 @@ Here is what a very basic recommendations file may look like: "guid": "PC2026" }, { - "link-type": "item", + "linkType": "item", "medium": "podcast", "title": "GO PODCASTING!!!", "image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg", @@ -179,14 +178,14 @@ Here is what a very basic recommendations file may look like: ```json { - "version": "1.2", + "version": "1.0", "title": "Podnews podcasting news", "feed": "https://podnews.net/rss", "guid": "9b024349-ccf0-5f69-a609-6b82873eab3c", "recommendations": [ { - "link-type": "none", + "linkType": "none", "medium": "text", "title": "Eat five vegetables every day.", "motive": "advertising" @@ -194,7 +193,7 @@ Here is what a very basic recommendations file may look like: { "displayStartTime": 0.0, "displayDuration": 120.0, - "link-type": "generic", + "linkType": "generic", "medium": "html", "title": "History of podcasting", "image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png", @@ -205,7 +204,7 @@ Here is what a very basic recommendations file may look like: { "displayStartTime": 120.50, "displayDuration": 60.0, - "link-type": "feed", + "linkType": "feed", "medium": "podcast", "title": "Podcasting 2.0", "image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg", @@ -217,7 +216,7 @@ Here is what a very basic recommendations file may look like: { "displayStartTime": 240.60, "displayDuration": 180.0, - "link-type": "feed-item", + "linkType": "feed-item", "medium": "podcast", "title": "Episode 26: Manning Battlestations", "image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg", @@ -229,7 +228,7 @@ Here is what a very basic recommendations file may look like: { "displayStartTime": 3600.10, "displayDuration": 60.0, - "link-type": "item", + "linkType": "item", "medium": "podcast", "title": "GO PODCASTING!!!", "image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg", From 6764cd351a4efac656072713aae6547f1fe11fdb Mon Sep 17 00:00:00 2001 From: Benjamin Bellamy Date: Tue, 31 Aug 2021 17:18:09 +0200 Subject: [PATCH 2/6] Update recommendations.md --- proposal-docs/recommendations/recommendations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposal-docs/recommendations/recommendations.md b/proposal-docs/recommendations/recommendations.md index 7766ef8..44cb946 100644 --- a/proposal-docs/recommendations/recommendations.md +++ b/proposal-docs/recommendations/recommendations.md @@ -86,7 +86,7 @@ There are 4 required attributes: - 'feed', - 'feed-item', - 'none' - - `medium` (required - string) The medium kind. It can be: + - `medium` (required - string) The medium type. It can be: - `podcast`, - `audiobook`, - `music`, From 472cee7aeb5f4dcf37dac02e03f0bd21ca496f8e Mon Sep 17 00:00:00 2001 From: Benjamin Bellamy Date: Tue, 31 Aug 2021 17:25:44 +0200 Subject: [PATCH 3/6] Update recommendations.md --- proposal-docs/recommendations/recommendations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposal-docs/recommendations/recommendations.md b/proposal-docs/recommendations/recommendations.md index 44cb946..383e64e 100644 --- a/proposal-docs/recommendations/recommendations.md +++ b/proposal-docs/recommendations/recommendations.md @@ -59,7 +59,7 @@ Example: ```json { - "version": "1.2", + "version": "1.0", "title": "Podnews podcasting news", "feed": "https://podnews.net/rss", "guid": "9b024349-ccf0-5f69-a609-6b82873eab3c" From 72f0b3ad135a3e71544467a86ad94dba4cc00cd4 Mon Sep 17 00:00:00 2001 From: Benjamin Bellamy Date: Tue, 31 Aug 2021 17:33:15 +0200 Subject: [PATCH 4/6] Update recommendations.md --- .../recommendations/recommendations.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/proposal-docs/recommendations/recommendations.md b/proposal-docs/recommendations/recommendations.md index 383e64e..10e0168 100644 --- a/proposal-docs/recommendations/recommendations.md +++ b/proposal-docs/recommendations/recommendations.md @@ -108,14 +108,14 @@ There are 4 required attributes: - `startTime` (optional - float) The start time (in seconds) of this recommended content. Applies to *"feed-item"* type only. - `duration` (optional - float) The duration (in seconds) of this recommended content. Applies to *"feed-item"* type only. - `motive` (optional - string) The reason why this content is recommended. It can be: - - `references`, - - `additional content`, - - `acknowledgment`, - - `advertising`, - - `audience exchange`, - - `similar content`, - - `also liked by the audience`, - - `made by the same people` + - `references` (content that was used when creating this podcast, similar to the Wikipedia References paragraph), + - `additional content` (content that provides extra information), + - `acknowledgment` (thanking people), + - `advertising` (sponsored content), + - `audience exchange` (exchanging audiences between podcasts), + - `content-based recommendation` (content related thank to semantic indexing), + - `audience-based recommendation` (people who liked this also liked…), + - `made by the same people` (the creators of this podcast also made that…) - `relevance` (optional - float) The relevance of this recommended content regarding this Channel or Item. Number must be in [0…1]. 0 is for irrelevant content, 1 is for contents that match perfectly. ## Basic example @@ -198,7 +198,7 @@ Here is what a very basic recommendations file may look like: "title": "History of podcasting", "image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png", "url": "https://en.wikipedia.org/wiki/History_of_podcasting", - "motive": "do you want to know more", + "motive": "additional content", "relevance": 0.8 }, { @@ -237,7 +237,7 @@ Here is what a very basic recommendations file may look like: "guid": "PC2026", "startTime": 4737.0, "duration": 5.0, - "motive": "do you want to know more", + "motive": "additional content", "relevance": 0.9 } ] From 450b7dd80a78928482fb0aa73f4bbbbb8665288f Mon Sep 17 00:00:00 2001 From: Benjamin Bellamy Date: Tue, 31 Aug 2021 17:33:57 +0200 Subject: [PATCH 5/6] Update recommendations.md --- proposal-docs/recommendations/recommendations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposal-docs/recommendations/recommendations.md b/proposal-docs/recommendations/recommendations.md index 10e0168..6da978a 100644 --- a/proposal-docs/recommendations/recommendations.md +++ b/proposal-docs/recommendations/recommendations.md @@ -113,7 +113,7 @@ There are 4 required attributes: - `acknowledgment` (thanking people), - `advertising` (sponsored content), - `audience exchange` (exchanging audiences between podcasts), - - `content-based recommendation` (content related thank to semantic indexing), + - `content-based recommendation` (content related thanks to semantic indexation), - `audience-based recommendation` (people who liked this also liked…), - `made by the same people` (the creators of this podcast also made that…) - `relevance` (optional - float) The relevance of this recommended content regarding this Channel or Item. Number must be in [0…1]. 0 is for irrelevant content, 1 is for contents that match perfectly. From cd9253e8976ec772204f3acaec7bd3e104a80f1c Mon Sep 17 00:00:00 2001 From: Benjamin Bellamy Date: Tue, 31 Aug 2021 17:35:22 +0200 Subject: [PATCH 6/6] Update recommendations.md --- proposal-docs/recommendations/recommendations.md | 1 + 1 file changed, 1 insertion(+) diff --git a/proposal-docs/recommendations/recommendations.md b/proposal-docs/recommendations/recommendations.md index 6da978a..b056851 100644 --- a/proposal-docs/recommendations/recommendations.md +++ b/proposal-docs/recommendations/recommendations.md @@ -15,6 +15,7 @@ This specification is about giving control to content creators on the content th - `GUID` support for channel element, - a `motive` tag that explains why a specific recommendation was included, - a `medium` tag so that this can work with any feed, including non-podcast medium. (See \ for more information.) + All this was heavily inspired by all the work previously done by the Fellowship of the PodcastIndex on the chapters and soundbite tags. May they be thanked for it. GO PODCASTING!!!