diff --git a/README.md b/README.md index c9acf4e..779deca 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,9 @@ will become the framework that the independent podcast community needs to delive **Phase 2** - [Closed] Comment period closed on `1/31/21` and 4 tags were adopted. -**Phase 3** - [Open] Proposals welcome. No dates assigned. +**Phase 3** - [Open] Proposals welcome. This phase will close on June 1st, 2021. At that time, any tags with full agreement will be reviewed for + formalization. Any tags with concerns or questions will be pushed forward to the next phase. Current tag proposals under + consideration are listed [here](#phase-3-open).

@@ -138,169 +140,63 @@ full implementation details.

-### Phase 3 (Open) +### Phase 3 (Open - Closes 6/1/21) -The following tags should be considered purely as proposals. They should not be relied upon or implemented except for testing purposes and experimentation. +The following tags should be considered purely as work in progress proposals. They should not be relied upon or implemented except for testing purposes and experimentation.
-- ****[license slug]**\** + - Channel or Item +``` + +[Title of Trailer(string)] + +``` - (optional | single) + - This element defines the license that is applied to the audio content of the episode or the audio of the podcast as a whole. The node value - should be a reference to a slug defined in the license slug file. +Channel - - `url` (optional) This is a url that points to the full license details for this license. +(optional | multiple) - Example: cc-by-4.0 +This element is used to define the location of an audio or video file to be used as a trailer for the entire podcast or a specific season. There can be more than one trailer present in the channel of the feed. If there is more than one listed, the most recent one according to it's `pubdate` should be chosen by default within podcast apps. If the `season` attribute is present, then the `` element it references must also be present within the feed. -
+- `pubdate` (required) The date the trailer was published. +- `url` (required) This is a url that points to the audio or video file to be played. +- `length` (recommended) The length of the file in bytes. +- `type` (recommended) The mime type of the file. +- `season` (optional) If this attribute is present it specifies that this trailer is for a particular season number. -- **\** +Example: +``` +Coming April 1st, 2021 +``` - Channel +Example with Season Linkage: +``` +Season 4: Race for the Whitehouse - (optional | multiple) +(combined with) - See "[IDs](#user-content-ids)" in this document for an explanation. - - - `platform` (required) This is the service slug of the platform. - - `id` (required) This is the unique identifier for this podcast on the respective platform. - - `url` (optional) A url to the page for this podcast on the respective platform. - -
- - -- **\**[social media handle]**\** - - Channel or Item - - (optional | multiple) - - This element lists social media accounts for this podcast. The service slugs should be community written into the accompanying serviceslugs.txt file. - - The maximum recommended string length of the node value is 128 characters. - -
- -- **\**[category Name]**\** - - Channel - - (optional | multiple) - - See "Categories" in this document for an explanation. There can be up to a total of 9 categories defined. - - There can be a maximum of 9 category elements defined in a feed. Any number greater than that should be discarded. - - Category names are defined in the accompanying "categories.json" file in this repository. They should be referenced in the element by their textual name. - The characters can be in any case. This list of categories aims to replicate the current standard but also eliminate as much as possible compound, heirarchical - naming and the use of ampersands. Thus, "Health & Fitness" becomes "Health" and "Fitness" as two distinct categories. And, "Religion & Spirituality" becomes - two separate categories. Again, they are different things that don't always go together. Splitting them allows for more flexible combinations. And, avoiding - ampersands makes xml encoding errors less likely. - -
- -- **\**[rating letter]**\** - - Channel or Item - - (optional | single) - - Specifies the generally accepted rating letter of G, PG, PG-13, R or X. Or, perhaps an age rating system like all, 14, 19, adult. Needs discussion. - -
- -- **\**[url this feed was imported from]**\** - - Channel - - (optional | multiple) - - Lists the previous url of this feed before it was imported. Any time a feed is moved, an additional **\** element - should be added to the channel, to create a paper trail of all the previous urls this feed has lived at. This way, aggregators can easily deduplicate their feed lists. - -
- -- **\** - - Channel (optional | single) - - Item (optional | multiple) - - This element is meant to provide alternate versions of an enclosure, such as low or high bitrate, or alternate formats or alternate uri schemes, like IPFS or live streaming. - There may be multiple alternateEnclosure elements in an item, but there must be no more than one in a channel. The presence of this element at the channel level would be - useful for adding a video/audio trailer or intro media that introduces the listener to the podcast. For instance, in a podcast of an audiobook, this could be the book's - introduction or preface. The alternateEnclosure element always refers to an "alternate" media version. The standard RSS enclosure element is always the default media to be played. - - An `` tag must be present along with this tag within the item. - - - `url` (required) This is the url to the media asset. - - `type` (required) Mime type of the media asset. - - `length` (required) Length of the file in bytes. - - `bitrate` (optional) Encoding bitrate of media asset. - - `title` (required) Alternate assets need a title since main title will apply to primary asset. - - `rel` (optional) Indicates what the purpose of this enclosure is. Like "lowbitrate" for a small file to use over cellular. - -
- -- **\** + **\[domain, bot or service slug]\** - - Channel (optional | single) - - The "indexers" element is meant as a container for one or more `` elements which send a signal to podcast aggregators whether they are allowed to pull and parse - this feed. If the aggregator is listed as blocked, it should take that as a signal by the feed owner to not index/aggregate this feed. - - *Note: this element needs a lot more discussion and work. This is just a placeholder for discussion.* - -
- -- **\** - - Channel or Item - - (optional | single) - - This points to a group of images, separated by commas - each with a pixel width declared after them. It is highly recommended that the images referenced - be square (1:1 ratio), as this is the industry standard for podcast album art, and what podcast apps expect to work with. The srcset attribute is designed - to work like the ```srcset``` attribute in the HTML5 specification. Suggested widths are 1500px, 600px, 300px and 150px. See the example feed in this - repo for an example of how this looks in practice. - - All attributes are required. - -
- -- **\**[email address or url]**\** - - Channel - - (optional | multiple) - - This element allows for listing different contact methods for the podcast owner. This could be for general feedback, advertising inquiries, abuse reports, etc. Only one element of each "type" - is allowed. - - All attributes are required. - -
- -- **\**[one or more "valueRecipient" elements]**\** - - Details for this tag are now located in dedicated documentation [here](value/value.md). - -- **\** - - Details for this tag are now located in dedicated documentation [here](value/value.md). +4 +```

+## Current Proposals + +A list of the current proposed tags can be found in the issues section [here](/labels/proposal). + + ## Verification for Importing and Transferring