kopia lustrzana https://github.com/Podcastindex-org/podcast-namespace
reorganize, reorder, reformat
Dave Jones
rodzic
ba248d3e86
commit
d98f960440
168
README.md
168
README.md
|
|
@ -43,49 +43,155 @@ this larger namespace.
|
|||
## Element List
|
||||
|
||||
### Phase 1 (Open)
|
||||
- **\<podcast:imageLarge size="[pixel width]">**[url to a large image file]**\</podcast:imageLarge>** - This is assumed to point to an image that is 1000px or larger in size.
|
||||
The image must be square (1:1 ratio). The image content may differ from other images specified in the feed where appropriate. The "size" attribute is mandatory.
|
||||
- **\<podcast:imageMedium size="[pixel width]">**[url to a medium image file]**\</podcast:imageMedium>** - This is assumed to point to an image that is 300px to 999px in size.
|
||||
The image must be square (1:1 ratio). The image content may differ from other images specified in the feed where appropriate. The "size" attribute is mandatory.
|
||||
- **\<podcast:imageSmall size="[pixel width]">**[url to a small image file]**\</podcast:imageSmall>** - This is assumed to point to an image that is 299px or less in size.
|
||||
The image must be square (1:1 ratio). The image content may differ from other images specified in the feed where appropriate. The "size" attribute is mandatory.
|
||||
|
||||
- **\<podcast:category>**[Category Name]**\</podcast:category>** - This is a channel-level element. See "Categories" in this document for an explanation. There can be up to a total of 9 categories defined.
|
||||
- **\<podcast:transcript language="[language code]" type="[mime type]">**[url to a file or website]**\</podcast:transcript>**
|
||||
|
||||
- **\<podcast:location osm_id="[place ID]">**[CountryCode|Locality]**\</podcast:location>** - The ISO 3166-1 alpha-2 country code; a pipe as separator; then a humanly-readable place name as preferred by the publisher.
|
||||
The (mandatory) parameter osm_id is the OpenStreetMap ID for that place, using OpenStreetMap's API.
|
||||
- **\<podcast:locked>**[yes|no]**\</podcast:locked>** - This is a channel-level element. This tells other podcast platforms whether they are allowed to import this feed. A value of "yes" means that any attempt to import
|
||||
this feed into a new platform should be rejected. It is expected that podcast hosting providers will enable a toggle in their GUI to allow their users to turn
|
||||
feed transfer lock on or off.
|
||||
- **\<podcast:email>**[email address]**\</podcast:email>** - This is a channel-level element. An email address that can be used to verify ownership of this feed during move and import operations. This could be a public email or a
|
||||
virtual email address at the hosting provider that redirects to the owner's true email address.
|
||||
- **\<podcast:previousUrl>**[url this feed was imported from]**\</podcast:previousUrl>** - This is a channel-level element. Lists the previous url of this feed before it was imported. Any time a feed is moved, an additional **\<podcast:previousUrl>** 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.
|
||||
- **\<podcast:newFeedUrl>**[the url the feed now lives at]**\</podcast:newFeedUrl>** - This is a channel-level element. If the feed moved, or was imported to a different hosting platform, this element may exist and specify the new location. It may refer
|
||||
to itself as a confirmation to aggregators that they now have the most current url.
|
||||
- **\<podcast:id platform="[service slug]">**[the id string]**\</podcast:id>** (optional|multiple) - This is a channel-level element. See "ID's" in this document for an explanation.
|
||||
Item
|
||||
|
||||
- **\<podcast:host href="[url of bio/wiki/blog/etc.]" img="[link to image/headshot]">**[name of person]**\</podcast:host>** (optional|multiple) - This is an item-level element. It identifies a host
|
||||
of a podcast episode. All other attributes are optional but recommended for disambiguation and good meta-data for apps.
|
||||
- **\<podcast:guest href="[url of bio/wiki/blog/etc.]" img="[link to image/headshot]">**[name of person]**\</podcast:guest>** (optional|multiple) - This is an item-level element. It identifies a guest
|
||||
in a podcast episode. All other attributes are optional but recommended for disambiguation and good meta-data for apps.
|
||||
- **\<podcast:contentRating>**[rating letter]**\</podcast:contentRating>** - This is a channel, or item-level element specifying a generally accepted rating letter of G, PG, PG-13, R or X.
|
||||
(optional|single)
|
||||
|
||||
- **\<podcast:transcript language="[language code]" type="[mime type]">**[url to a file or website]**\</podcast:transcript>** - This is an item-level element. Links to an external file containing a transcript. The
|
||||
mime type of the file should be given - such as text/plain, text/html, etc.
|
||||
- **\<podcast:captions language="[language code]" type="text/srt">**[url to a SRT captions file]**\</podcast:captions>** - This is an item-level element. Links to an industry standard closed-caption/subtitle file format.
|
||||
- **\<podcast:alternateEnclosure type="[mime type]" length="[(int)]" bitrate="[(float)]" title="[(string)]" [live]>**[uri of media asset]**\</podcast:alternateEnclosure>** - This is a channel or item-level
|
||||
element that 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. The title attribute is optional. The "live" attribute is unary - its presence indicates that
|
||||
Links to an external file containing a transcript. The mime type of the file should be given - such as text/plain, text/html, etc.
|
||||
|
||||
- **\<podcast:captions language="[language code]" type="text/srt">**[url to a SRT captions file]**\</podcast:captions>**
|
||||
|
||||
Item
|
||||
|
||||
(optional|single)
|
||||
|
||||
Links to an industry standard closed-caption/subtitle file format.
|
||||
|
||||
- **\<podcast:alternateEnclosure type="[mime type]" length="[(int)]" bitrate="[(float)]" title="[(string)]" [live]>**[uri of media asset]**\</podcast:alternateEnclosure>**
|
||||
|
||||
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. The title attribute is optional. The "live" attribute is unary - its presence indicates that
|
||||
the uri refers to a live stream. 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.
|
||||
|
||||
- **\<podcast:location osm_id="[place ID]">**[CountryCode|Locality]**\</podcast:location>**
|
||||
|
||||
Channel or Item
|
||||
|
||||
(required|single)
|
||||
|
||||
The ISO 3166-1 alpha-2 country code; a pipe as separator; then a humanly-readable place name as preferred by the publisher.
|
||||
The (mandatory) parameter osm_id is the OpenStreetMap ID for that place, using OpenStreetMap's API.
|
||||
|
||||
- **\<podcast:locked>**[yes|no]**\</podcast:locked>**
|
||||
|
||||
Channel
|
||||
|
||||
(required|single)
|
||||
|
||||
This tells other podcast platforms whether they are allowed to import this feed. A value of "yes" means that any attempt to import
|
||||
this feed into a new platform should be rejected. It is expected that podcast hosting providers will enable a toggle in their GUI to allow their users to turn
|
||||
feed transfer lock on or off.
|
||||
|
||||
- **\<podcast:verificationEmail>**[email address]**\</podcast:verificationEmail>**
|
||||
|
||||
Channel
|
||||
|
||||
(required|single)
|
||||
|
||||
This is a channel-level element. An email address that can be used to verify ownership of this feed during move and import operations. This could be a public email or a
|
||||
virtual email address at the hosting provider that redirects to the owner's true email address.
|
||||
|
||||
- **\<podcast:imageLarge size="[pixel width]">**[url to a large image file]**\</podcast:imageLarge>**
|
||||
|
||||
Channel or Item
|
||||
|
||||
(optional|single)
|
||||
|
||||
This is assumed to point to an image that is 1000px or larger in size. The image must be square (1:1 ratio). The image content may differ from other images specified in
|
||||
the feed where appropriate. The "size" attribute is mandatory.
|
||||
|
||||
- **\<podcast:imageMedium size="[pixel width]">**[url to a medium image file]**\</podcast:imageMedium>**
|
||||
|
||||
Channel or Item
|
||||
|
||||
(optional|single)
|
||||
|
||||
This is assumed to point to an image that is 300px to 999px in size.
|
||||
The image must be square (1:1 ratio). The image content may differ from other images specified in the feed where appropriate. The "size" attribute is mandatory.
|
||||
|
||||
- **\<podcast:imageSmall size="[pixel width]">**[url to a small image file]**\</podcast:imageSmall>**
|
||||
|
||||
Channel or Item
|
||||
|
||||
(optional|single)
|
||||
|
||||
This is assumed to point to an image that is 299px or less in size.
|
||||
The image must be square (1:1 ratio). The image content may differ from other images specified in the feed where appropriate. The "size" attribute is mandatory.
|
||||
|
||||
- **\<podcast:category>**[Category Name]**\</podcast:category>**
|
||||
|
||||
Channel
|
||||
|
||||
(optional|single)
|
||||
|
||||
See "Categories" in this document for an explanation. There can be up to a total of 9 categories defined.
|
||||
|
||||
- **\<podcast:previousUrl>**[url this feed was imported from]**\</podcast:previousUrl>**
|
||||
|
||||
Channel
|
||||
|
||||
(optional|multiple)
|
||||
|
||||
Lists the previous url of this feed before it was imported. Any time a feed is moved, an additional **\<podcast:previousUrl>** 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.
|
||||
|
||||
- **\<podcast:newFeedUrl>**[the url the feed now lives at]**\</podcast:newFeedUrl>**
|
||||
|
||||
Channel
|
||||
|
||||
(optional|single)
|
||||
|
||||
If the feed moved, or was imported to a different hosting platform, this element may exist and specify the new location. It may refer
|
||||
to itself as a confirmation to aggregators that they now have the most current url.
|
||||
|
||||
- **\<podcast:id platform="[service slug]">**[the id string]**\</podcast:id>**
|
||||
|
||||
Channel
|
||||
|
||||
(optional|multiple)
|
||||
|
||||
See "ID's" in this document for an explanation.
|
||||
|
||||
- **\<podcast:host href="[url of bio/wiki/blog/etc.]" img="[link to image/headshot]">**[name of person]**\</podcast:host>**
|
||||
|
||||
Channel or Item
|
||||
|
||||
(optional|multiple)
|
||||
|
||||
It identifies a host of a podcast episode or entire podcast. All attributes are optional but recommended for disambiguation and good meta-data for apps.
|
||||
|
||||
- **\<podcast:guest href="[url of bio/wiki/blog/etc.]" img="[link to image/headshot]">**[name of person]**\</podcast:guest>**
|
||||
|
||||
Item
|
||||
|
||||
(optional|multiple)
|
||||
|
||||
It identifies a guest in a podcast episode. All attributes are optional but recommended for disambiguation and good meta-data for apps.
|
||||
|
||||
- **\<podcast:contentRating>**[rating letter]**\</podcast:contentRating>**
|
||||
|
||||
Channel or Item
|
||||
|
||||
(optional|single)
|
||||
|
||||
Specifies the generally accepted rating letter of G, PG, PG-13, R or X.
|
||||
|
||||
|
||||
|
||||
### Phase 2 (Open)
|
||||
|
||||
- **\<podcast:social platform="[service slug]" url="[link to social media account]">**[social media handle]**\</podcast:social>** (optional|multiple) - This is a channel-level
|
||||
element listing possibly multiple social media accounts for this podcast. The service slugs should be community written in the accompanying serviceslugs.txt file.
|
||||
|
||||
- **\<podcast:funding platform="[service slug]" url="[url for the show at the platform]">**[podcast handle at the platform]**\</podcast:funding>** - (optional|multiple) - This is a
|
||||
channel-level element listing multiple possible donation/funding links for the podcast.
|
||||
|
||||
|
|
@ -135,4 +241,4 @@ More should be added by the community as needed. This is just a starter list.
|
|||
|
||||
## Example feed
|
||||
|
||||
There is an example feed in this repository showing the podcastindex namespace side by side with the Apple itunes namespace.
|
||||
There is an example feed (example.xml) in this repository showing the podcastindex namespace side by side with the Apple itunes namespace.
|
||||
Ładowanie…
Reference in New Issue