mirror
/
podcast-namespace
kopia lustrzana https://github.com/Podcastindex-org/podcast-namespace
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Update recommendations.md

pull/291/head
Benjamin Bellamy 2021-08-31 17:16:54 +02:00 zatwierdzone przez GitHub
rodzic 095ab62fa6
commit f14f767589
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
1 zmienionych plików z 16 dodań i 17 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

33
proposal-docs/recommendations/recommendations.md
Wyświetl plik

@ -1,6 +1,6 @@
# The "podcast:recommendations" Specification # The "podcast:recommendations" Specification
<small>Version 1.2 by Benjamin Bellamy - 2021.08.31</small> <small>Version 1.0 by Benjamin Bellamy - 2021.08.31</small>
<br> <br>
@ -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. 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. 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. 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, - `GUID` support for channel element,
- a `motive` tag that explains why a specific recommendation was included, - 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 \<podcast:medium> for more information.) - a `medium` tag so that this can work with any feed, including non-podcast medium. (See \<podcast:medium> 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. 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!!! GO PODCASTING!!!
@ -73,7 +72,7 @@ The "recommendation" object takes this basic form:
```json ```json
{ {
"link-type": "generic", "linkType": "generic",
"title": "History of podcasting", "title": "History of podcasting",
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png", "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" "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: 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', - 'generic',
- 'feed', - 'feed',
- 'feed-item', - 'feed-item',
@ -125,17 +124,17 @@ Here is what a very basic recommendations file may look like:
```json ```json
{ {
"version": "1.2", "version": "1.0",
"recommendations": "recommendations":
[ [
{ {
"link-type": "none", "linkType": "none",
"medium": "text", "medium": "text",
"title": "Eat five vegetables every day.", "title": "Eat five vegetables every day.",
"motive": "advertising" "motive": "advertising"
}, },
{ {
"link-type": "generic", "linkType": "generic",
"medium": "html", "medium": "html",
"title": "History of podcasting", "title": "History of podcasting",
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png", "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" "motive": "additional content"
}, },
{ {
"link-type": "feed", "linkType": "feed",
"medium": "podcast", "medium": "podcast",
"title": "Podcasting 2.0", "title": "Podcasting 2.0",
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg", "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" "motive": "audience exchange"
}, },
{ {
"link-type": "item", "linkType": "item",
"medium": "podcast", "medium": "podcast",
"title": "Episode 26: Manning Battlestations", "title": "Episode 26: Manning Battlestations",
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg", "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" "guid": "PC2026"
}, },
{ {
"link-type": "item", "linkType": "item",
"medium": "podcast", "medium": "podcast",
"title": "GO PODCASTING!!!", "title": "GO PODCASTING!!!",
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg", "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 ```json
{ {
"version": "1.2", "version": "1.0",
"title": "Podnews podcasting news", "title": "Podnews podcasting news",
"feed": "https://podnews.net/rss", "feed": "https://podnews.net/rss",
"guid": "9b024349-ccf0-5f69-a609-6b82873eab3c", "guid": "9b024349-ccf0-5f69-a609-6b82873eab3c",
"recommendations": "recommendations":
[ [
{ {
"link-type": "none", "linkType": "none",
"medium": "text", "medium": "text",
"title": "Eat five vegetables every day.", "title": "Eat five vegetables every day.",
"motive": "advertising" "motive": "advertising"
@ -194,7 +193,7 @@ Here is what a very basic recommendations file may look like:
{ {
"displayStartTime": 0.0, "displayStartTime": 0.0,
"displayDuration": 120.0, "displayDuration": 120.0,
"link-type": "generic", "linkType": "generic",
"medium": "html", "medium": "html",
"title": "History of podcasting", "title": "History of podcasting",
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png", "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, "displayStartTime": 120.50,
"displayDuration": 60.0, "displayDuration": 60.0,
"link-type": "feed", "linkType": "feed",
"medium": "podcast", "medium": "podcast",
"title": "Podcasting 2.0", "title": "Podcasting 2.0",
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg", "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, "displayStartTime": 240.60,
"displayDuration": 180.0, "displayDuration": 180.0,
"link-type": "feed-item", "linkType": "feed-item",
"medium": "podcast", "medium": "podcast",
"title": "Episode 26: Manning Battlestations", "title": "Episode 26: Manning Battlestations",
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg", "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, "displayStartTime": 3600.10,
"displayDuration": 60.0, "displayDuration": 60.0,
"link-type": "item", "linkType": "item",
"medium": "podcast", "medium": "podcast",
"title": "GO PODCASTING!!!", "title": "GO PODCASTING!!!",
"image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg", "image": "https://noagendaassets.com/enc/1601061118.678_pciavatar.jpg",