From c2b8eb73cd4e0df72437ef42536efe824c8e56c8 Mon Sep 17 00:00:00 2001 From: Dave Jones Date: Wed, 1 Sep 2021 11:54:32 -0500 Subject: [PATCH] gateway episodes --- README.md | 97 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 97 insertions(+) diff --git a/README.md b/README.md index d59597e..1d770d2 100644 --- a/README.md +++ b/README.md @@ -300,6 +300,103 @@ Example use for "music":
+---- + +### **\** - [Discuss](https://github.com/Podcastindex-org/podcast-namespace/issues/281) + +
+ + + +```xml + +[free form message to listeners(string)] + +``` + + + +Item + +(optional | multiple) + +This tag, when present in an `` indicates that this episode is a so-called "gateway episode". Gateway episodes are episodes that the podcaster (or maybe crowd sourced) thinks +represent the best entry point into a long running show. If a podcast has 300 episodes, it might be a good idea to designate 1 or more older episodes as the best place to start. + +The `order` attribute is an unsigned integer that is meant as an ascending listening order. The episode with `order="1"` should be played first, then `order="2"` and so on. + +When podcast apps encounter gateway episodes, it is suggested that they present these episodes (in some form of UI) to the user when the user subscribes or follows the podcast. + +Example of a single gateway: +```xml + + Podcasting 2.0 - How it all Began + A look into the future of podcasting and how we get to Podcasting 2.0! + https://example.com/pc20/ep1 + https://example.com/pc20/ep1 + John Doe (john@example.com) + + Adam Curry + Dave Jones + Becky Smith + + Start here! + +``` + +Example of a gateway series: +```xml + + Podcasting 2.0 - How it all Began + A look into the future of podcasting and how we get to Podcasting 2.0! + https://example.com/pc20/ep1 + https://example.com/pc20/ep1 + John Doe (john@example.com) + + Adam Curry + Dave Jones + Becky Smith + + Fri, 11 Sep 2020 18:51:09 GMT + 1 + 1 + Start here! + + + + Podcasting 2.0 - The tide has turned + What a big week. So many important things happened this week. We dive into it all and what it means! + https://example.com/pc20/ep45 + https://example.com/pc20/ep45 + John Doe (john@example.com) + + Adam Curry + Dave Jones + Becky Smith + + Fri, 20 Aug 2021 20:23:55 GMT + 45 + 45 + We reached a milestone here! + +``` + +
+ ## Other Proposals A list of the current proposed tags can be found in the issues section [here](https://github.com/Podcastindex-org/podcast-namespace/labels/proposal).