Skip to content

Commit 40656e2

Browse files
authored
Merge pull request #526 from Podcastindex-org/phase-6
phase 6 - remoteItem and podroll tags
2 parents 7968134 + db62327 commit 40656e2

File tree

3 files changed

+842
-249
lines changed

3 files changed

+842
-249
lines changed

README.md

Lines changed: 82 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,112 +1,136 @@
11
# The "podcast" Namespace
22

3-
A wholistic rss namespace for podcasting that is meant to synthesize the fragmented world of podcast namespaces. The broad goal is to create a single, compact, efficient
4-
namespace that is easily extensible, community controlled/authored and addresses the needs of the independent podcast industry now and in the future.
5-
Our hope is that this namespace
6-
will become the framework that the independent podcast community needs to deliver new functionality to apps and aggregators.
3+
A wholistic rss namespace for podcasting that is meant to synthesize the fragmented world of podcast namespaces. The
4+
broad goal is to create a single, compact, efficient namespace that is easily extensible, community
5+
controlled/authored and addresses the needs of the independent podcast industry now and in the future. Our hope is
6+
that this namespace will become the framework that the independent podcast community needs to deliver new
7+
functionality to apps and aggregators.
78

89

9-
Our guiding principles for development of this namespace are the "[Rules for Standards Makers](http://scripting.com/2017/05/09/rulesForStandardsmakers.html)" by Dave Winer.
10-
Please read it before contributing if you aren't familiar with it.
10+
Our guiding principles for development of this namespace are the
11+
"[Rules for Standards Makers](http://scripting.com/2017/05/09/rulesForStandardsmakers.html)" by Dave Winer. Please
12+
read it before contributing if you aren't familiar with it.
1113

12-
The podcast namespace is part of the larger "Podcasting 2.0" project which exists to bring control of podcasting's protocols back into the hands of the open podcasting community. A good overview can be found here: [Podcasting 2.0](podcasting2.0.md)
14+
The podcast namespace is part of the larger "Podcasting 2.0" project which exists to bring control of podcasting's
15+
protocols back into the hands of the open podcasting community. A good overview can be found here:
16+
[Podcasting 2.0](podcasting2.0.md)
1317

1418
* [Official XMLNS Definition](docs/1.0.md) the official definition of all formalized tags.
15-
* List of platforms and apps that currently implement some or all of these tags: [Supporting Platforms and Apps](docs/element-support.md).
16-
* Example Feed: There is an example feed [example.xml](example.xml) in this repository showing the podcastindex namespace side by side with the Apple itunes namespace.
17-
* [Other recommendations](docs/other-recommendations.md) when creating RSS podcast feeds.
19+
* List of platforms and apps that currently implement some or all of these
20+
tags: [Supporting Platforms and Apps](docs/element-support.md).
21+
* Example Feed: There is an example feed [example.xml](example.xml) in this repository showing the podcastindex
22+
namespace side by side with the Apple itunes namespace. * [Other recommendations](docs/other-recommendations.md)
23+
when creating RSS podcast feeds.
1824

1925

2026
<br><br>
2127

2228

2329
## Current Roadmap
2430

25-
**Phase 1** - [Closed] Comment period closed on `11/15/2020` and [5 tags](https://github.com/Podcastindex-org/podcast-namespace#phase-1-closed-on-111520) were **formalized**.
31+
**Phase 1** - [Closed] Comment period closed on `11/15/2020` and [5 tags](#phase-1-closed-on-111520) were
32+
**formalized**.
2633

27-
**Phase 2** - [Closed] Comment period closed on `1/31/2021` and [4 tags](https://github.com/Podcastindex-org/podcast-namespace#phase-2-closed-on-13121) were **formalized**.
34+
**Phase 2** - [Closed] Comment period closed on `1/31/2021` and [4 tags](#phase-2-closed-on-13121) were **formalized**.
2835

29-
**Phase 3** - [Closed] Comment period closed on `6/1/2021` and [5 tags](https://github.com/Podcastindex-org/podcast-namespace#phase-3-closed-on-6121) were **formalized**.
36+
**Phase 3** - [Closed] Comment period closed on `6/1/2021` and [5 tags](#phase-3-closed-on-6121) were **formalized**.
3037

31-
**Phase 4** - [Closed] Comment period closed on `12/1/2021` and [3 tags](https://github.com/Podcastindex-org/podcast-namespace#phase-4-closed-on-1212021) were **formalized**.
38+
**Phase 4** - [Closed] Comment period closed on `12/1/2021` and [3 tags](#phase-4-closed-on-1212021) were
39+
**formalized**.
3240

33-
**Phase 5** - [Closed] Comment period closed on `7/15/2022` and [2 tags](https://github.com/Podcastindex-org/podcast-namespace#phase-5-closed-as-of-7152022) were **formalized**.
41+
**Phase 5** - [Closed] Comment period closed on `7/15/2022` and [2 tags](#phase-5-closed-as-of-7152022) were
42+
**formalized**.
3443

35-
**Phase 6** - [Open] Comment period is now open as of `9/28/2022`. Proposals are welcome. The following tags are being considered: [Phase 6 tag list](https://github.com/Podcastindex-org/podcast-namespace/discussions?discussions_q=is%3Aopen+label%3Aphase6)
44+
**Phase 6** - [Closed] Comment period closed on `6/1/2023` and [6 tags](#phase-6-closed-as-of-612023) were
45+
**formalized**.
3646

3747
<br><br>
3848

3949

4050
## Legend
4151

42-
**Formalized** - This tag is frozen and listed in the XMLNS document. Any future changes to it's definition must maintain backwards compatibility.
52+
**Formalized** - This tag is frozen and listed in the XMLNS document. Any future changes to it's definition must
53+
maintain backwards compatibility.
4354

44-
**Finalized** - The tag is structurally stable and implementation testing should be considered safe. Any breaking changes will be widely communicated.
55+
**Finalized** - The tag is structurally stable and implementation testing should be considered safe. Any breaking
56+
changes will be widely communicated.
4557

4658
**Open** - The tag/phase is open for discussion and collaboration.
4759

4860
**Required** - This tag or attribute must be present.
4961

5062
**Optional** - This tag or attribute may be left out.
5163

52-
**Recommended** - This tag or attribute is technically optional, but is strongly recommended to be present for the tag to function as fully intended.
64+
**Recommended** - This tag or attribute is technically optional, but is strongly recommended to be present for the
65+
tag to function as fully intended.
5366

5467

5568
<br><br>
5669

5770

5871
## Tag Adoption Process
5972

60-
To be adopted as an official part of the namespace, there must be consensus around a tag's usefulness and either commitment to adoption by at least 1 host and 1 app, or a recognition
61-
that the tag is already being used in the wild.
73+
To be adopted as an official part of the namespace, there must be consensus around a tag's usefulness and either
74+
commitment to adoption by at least 1 host and 1 app, or a recognition that the tag is already being used in the wild.
6275

63-
It is ALWAYS ok to delay a tag to a future Phase if there is any concern about it. That is to be expected and encouraged.
76+
It is ALWAYS ok to delay a tag to a future Phase if there is any concern about it. That is to be expected and
77+
encouraged.
6478

65-
When a Phase comes to a close, there will be a full review of any tags currently open for comment and questions will be asked to gather consensus before final adoption. No tags
66-
will be adopted by fiat, or if there are unresolved questions. They will just be moved to the next Phase for further comment and refinement.
79+
When a Phase comes to a close, there will be a full review of any tags currently open for comment and questions will
80+
be asked to gather consensus before final adoption. No tags will be adopted by fiat, or if there are unresolved
81+
questions. They will just be moved to the next Phase for further comment and refinement.
6782

68-
Tags that are proposals or rough ideas should be expected to have syntax problems or typos. Those should be refined away as they are worked on. If they are not, that is a good idea
69-
that the tag in question isn't being seen as useful and should be considered for dropping.
83+
Tags that are proposals or rough ideas should be expected to have syntax problems or typos. Those should be refined
84+
away as they are worked on. If they are not, that is a good idea that the tag in question isn't being seen as
85+
useful and should be considered for dropping.
7086

71-
We are not a "standards body". It is a community driven project where all stake holders are encouraged to participate, so that many voices are heard. This is an open-source
72-
project to be built fully in the open. Discussions also take place on [podcastindex.social](https://podcastindex.social) where anyone is free to register and participate.
87+
We are not a "standards body". It is a community driven project where all stake holders are encouraged to
88+
participate, so that many voices are heard. This is an open-source project to be built fully in the open.
89+
Discussions also take place on [podcastindex.social](https://podcastindex.social) where anyone is free to register
90+
and participate.
7391

7492

7593
<br><br>
7694

7795

7896
### Goal #1 - Eliminate Redundancy
7997

80-
There is significant overlap amongst the many existing podcast namespaces. Each platform and publisher has created their own namespace to give their respective
81-
system and audience the metadata they need in the way they want it delivered.
98+
There is significant overlap amongst the many existing podcast namespaces. Each platform and publisher has created
99+
their own namespace to give their respective system and audience the metadata they need in the way they want it
100+
delivered.
82101

83102

84103
### Goal #2 - Keep "required" tags and attributes minimal
85104

86-
The only required tags should be those that solve an overwhelming need in the industry. Requiring tags is a roadblock to adoption and should be avoided. Attributes
87-
should also only be required when they are key to the functionality of the tag.
105+
The only required tags should be those that solve an overwhelming need in the industry. Requiring tags is a
106+
roadblock to adoption and should be avoided. Attributes should also only be required when they are key to the
107+
functionality of the tag.
88108

89109

90110
### Goal #3 - Keep Exisiting Conventions
91111

92-
Reinventing the wheel helps nobody. When at all possible, existing conventions should be maintained. For example, it would make sense to turn **\<podcast:explicit>** into
93-
a unary element, where it's existence is taken as a "yes" and it's absence as a "no". But, that has never been the standard. And, given as how this namespace will probably
112+
Reinventing the wheel helps nobody. When at all possible, existing conventions should be maintained. For example,
113+
it would make sense to turn **\<podcast:explicit>** into a unary element, where it's existence is taken as a "yes"
114+
and it's absence as a "no". But, that has never been the standard. And, given as how this namespace will probably
94115
sit alongside at least one other namespace, it makes sense to keep existing conventions in place.
95116

96117

97118
### Goal #4 - Be General... to a point
98119

99-
There is no way to address every possible metadata point that each platform would want. That is not the aim. Instead we focus on defining the elements that would be useful
100-
to the broadest set of apps, publishers, platforms and aggregators. Individual parties can keep their respective supplemental namespaces small and targeted as an adjunct to
101-
this larger namespace. But, we don't want to be so general that the spec becomes overly complicated. A beautiful, "perfect" spec is not important. Solving real problems is.
120+
There is no way to address every possible metadata point that each platform would want. That is not the aim.
121+
Instead we focus on defining the elements that would be useful to the broadest set of apps, publishers, platforms
122+
and aggregators. Individual parties can keep their respective supplemental namespaces small and targeted as an
123+
adjunct to this larger namespace. But, we don't want to be so general that the spec becomes overly complicated. A
124+
beautiful, "perfect" spec is not important. Solving real problems is.
102125

103126

104127
<br><br>
105128

106129

107130
## Copying information
108131

109-
The "podcast" namespace is [dedicated to the public domain using CC0 v1.0](COPYING.txt) so as to remove all barriers to adoption, development and contribution.
132+
The "podcast" namespace is [dedicated to the public domain using CC0 v1.0](COPYING.txt) so as to remove all barriers
133+
to adoption, development and contribution.
110134

111135

112136
<br><br>
@@ -118,8 +142,8 @@ The "podcast" namespace is [dedicated to the public domain using CC0 v1.0](COPYI
118142

119143
<br>
120144

121-
The following tags have been formally adopted into the namespace. They are fully documented in the XMLNS document located [here](docs/1.0.md). Please see that file for
122-
full implementation details.
145+
The following tags have been formally adopted into the namespace. They are fully documented in the XMLNS document
146+
located [here](docs/1.0.md). Please see that file for full implementation details.
123147

124148
- **\<podcast:locked>** <br>
125149
- **\<podcast:transcript>** <br>
@@ -133,8 +157,8 @@ full implementation details.
133157

134158
<br>
135159

136-
The following tags have been formally adopted into the namespace. They are fully documented in the XMLNS document located [here](docs/1.0.md). Please see that file for
137-
full implementation details.
160+
The following tags have been formally adopted into the namespace. They are fully documented in the XMLNS document
161+
located [here](docs/1.0.md). Please see that file for full implementation details.
138162

139163
- **\<podcast:person>** <br>
140164
- **\<podcast:location>** <br>
@@ -148,8 +172,8 @@ full implementation details.
148172

149173
<br>
150174

151-
The following tags have been formally adopted into the namespace. They are fully documented in the XMLNS document located [here](docs/1.0.md). Please see that file for
152-
full implementation details.
175+
The following tags have been formally adopted into the namespace. They are fully documented in the XMLNS document
176+
located [here](docs/1.0.md). Please see that file for full implementation details.
153177

154178
- **\<podcast:trailer>** <br>
155179
- **\<podcast:license>** <br>
@@ -165,8 +189,8 @@ full implementation details.
165189

166190
<br>
167191

168-
The following tags have been formally adopted into the namespace. They are fully documented in the XMLNS document located [here](docs/1.0.md). Please see that file for
169-
full implementation details.
192+
The following tags have been formally adopted into the namespace. They are fully documented in the XMLNS document
193+
located [here](docs/1.0.md). Please see that file for full implementation details.
170194

171195
- **\<podcast:medium>** <br>
172196
- **\<podcast:images>** <br>
@@ -179,30 +203,32 @@ full implementation details.
179203

180204
<br>
181205

182-
The following tags have been formally adopted into the namespace. They are fully documented in the XMLNS document located [here](docs/1.0.md). Please see that file for
183-
full implementation details.
206+
The following tags have been formally adopted into the namespace. They are fully documented in the XMLNS document
207+
located [here](docs/1.0.md). Please see that file for full implementation details.
184208

185209
- **\<podcast:socialInteract>** <br>
186210
- **\<podcast:block>** <br>
187211

188212
<br>
189213

190-
## <u>Phase 6 (Open as of 9/28/2022)</u>
214+
## <u>Phase 6 (Closed as of 6/1/2023)</u>
191215

192-
Tags [listed here](https://github.com/Podcastindex-org/podcast-namespace/labels/phase6) are under consideration for inclusion in this phase. New tag submissions are welcome.
193-
194-
Additionally, the following tags have been formally adopted into the namespace in this phase:
216+
The following tags have been formally adopted into the namespace. They are fully documented in the XMLNS document
217+
located [here](docs/1.0.md). Please see that file for full implementation details.
195218

196219
- **\<podcast:txt>** <br>
197-
198-
They are fully documented in the XMLNS document located [here](docs/1.0.md). Please see that file for full implementation details.
199-
220+
- **\<podcast:remoteItem>** <br>
221+
- **\<podcast:podroll>** <br>
222+
- **\<podcast:updateFrequency>** <br>
223+
- **\<podcast:podping>** <br>
224+
- **\<podcast:valueTimeSplit>** <br>
200225

201226
<br>
202227

203228
## Other Proposals
204229

205-
A list of the current proposed tags can be found in the issues section [here](https://github.com/Podcastindex-org/podcast-namespace/labels/proposal).
230+
A list of the current proposed tags can be found in the issues
231+
section [here](https://github.com/Podcastindex-org/podcast-namespace/labels/proposal).
206232

207233
<br><br>
208234

0 commit comments

Comments
 (0)