Skip to content

Commit

Permalink
Merge pull request #1 from Podcastindex-org/main
Browse files Browse the repository at this point in the history
new
  • Loading branch information
Lehmancreations authored Nov 30, 2020
2 parents 1d03ea8 + 03bd4c3 commit aaae2ff
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 25 deletions.
53 changes: 30 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,43 +111,61 @@ full implementation details.

### <u>Phase 2 (Open)</u>

- **\<podcast:person role="[host or guest]" img="[(uri of content)]" href="[(uri to website/wiki/blog)]">**[name of person]**</podcast:person>**
- **\<podcast:person name="[name of person]" (role="[host,guest,etc.]") (group="[cast,writing,etc.]") (img="[uri of content]") (href="[uri to Podchaser/website/wiki/blog]") />**

Channel or Item (optional | multiple)

This element specifies a person of interest to the podcast.
This element specifies a person of interest to the podcast. It is primarily intended to identify people like hosts, co-hosts and guests. Although, it is flexible enough to allow fuller credits to be given using the roles
and groups that are listed in the Podcast Taxonomy Project. (link needed)

- `name` (required) This is the full name or alias of the person.
- `role` (optional) Used to identify what role the person has for the show or episode. Currently there are two defined roles: "host" or "guest". If role is missing then "host" is assumed.
- `role` (optional) Used to identify what role the person serves on the show or episode. This should be a reference to an official role within the Podcast Taxonomy Project list. If `role` is missing then "host" is assumed.
- `group` (optional) This should be a camel-cased, alphanumeric reference to an official group within the Podcast Taxonomy Project list. If `group` is not present, then "cast" is assumed.
- `img` (optional) This is the url of a picture or avatar of the person.
- `href` (optional) Link to a relevant resource of information about the person. (eg. website, blog or wiki entry).
- `href` (optional) Link to a relevant resource of information about the person. (eg. Podchaser profile, website, blog or wiki entry). Linking to the Podchaser profile url is highly encouraged as the standard for this url. In a case
where there is no Podchaser profile, then a link to the person's website, blog, wiki entry, etc. can be used.

The maximum recommended string length of the node value is 128 characters.

<br>

- **\<podcast:location country="[Country Code]" locality="[Locality]" latlon="[latitude,longitude]" (osmid="[OSM type][OSM id]") />**
- **\<podcast:location country="[Country Code]" (locality="[Locality]") (latlon="[latitude,longitude]") (osmid="[OSM type][OSM id]") />**

Channel (optional | single)

Item (optional | multiple)

This element must contain, at minimum, a latlon point and a country code. Although, an OSM specification is highly recommended. The purpose of this tag is to allow specifying
This element must contain, at minimum, a country code. Although, an OSM specification or latitude/longitude is highly recommended. The purpose of this tag is to allow specifying
locations relevant to this podcast or episode. It can be used as simply as a single tag in the channel to show the "home base" of where a podcast is produced. Or, more thoroughly
for a travel podcast to specify locations that were visited during each episode. Also, a history podcast could reference points of interest discussed. There are many possible uses.

- latlon: (required) A latitude/longitude point reflecting the location associated with this show or episode. This could be where it is made, or alternatively a location which
The country code is required, but if either `osmid` or `latlon` is present in the tag, it will take priority over the country code.

- `country`: (required) The ISO 3166-1 alpha-2 country code, eg 'US'. (Note that the United Kingdom is 'GB', not 'UK'.)
- `locality`: (recommended) This is a humanly-readable place name as preferred by the podcast publisher for display in an app. Valid values are "Houses of Parliament", or "North Michigan", or "27 Acacia Avenue, Hammersmith".
For programmatic use, developers should use latlon or (better) geo-IDs.
- `latlon`: (recommended) A latitude/longitude point reflecting the location associated with this show or episode. This could be where it is made, or alternatively a location which
features in the podcast.
- osmid: (recommended) From the OpenStreetMap API. If a value is given for osmid it must contain both 'type' and 'id'.
- `osmid`: (recommended) From the OpenStreetMap API. If a value is given for osmid it must contain both 'type' and 'id'.
- osm type: A one-character description of the type of OSM point. Valid is "N" (node); "W" (way); "R" (relation).
- osm id: The ID of the OpenStreetMap feature that is described. This may be a city or a building. While OSM IDs are not considered permanent, cities rarely disappear.
- CountryCode: (required) The ISO 3166-1 alpha-2 country code, eg 'US'. (Note that the United Kingdom is 'GB', not 'UK'.)
- Locality: (recommended) With a pipe separator from the countrycode, this is a humanly-readable place name as preferred by the podcast publisher.

The maximum recommended string character length of the node value is 128 characters.

<br>

- **\<podcast:season title="[title of season]">**[(int)]**\</podcast:season>**

Item

(optional | single)

This element allows for identifying which episodes in a podcast are part of a "season", and allowing that season to have a title associate with it. The element's value is an integer identifying the season number.

All attributes are optional.

<br>

- **\<podcast:social platform="[service slug]" url="[link to social media account]">**[social media handle]**\</podcast:social>**

Channel or Item
Expand Down Expand Up @@ -256,7 +274,7 @@ full implementation details.

(optional | multiple)

See "ID's" in this document for an explanation.
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.
Expand Down Expand Up @@ -301,17 +319,6 @@ full implementation details.
- `address` (required) The address of the digital wallet or node that will receive payments.
- `split` (required) Defines a percentage that this payment destination represents. Payments will be sent to each destination in the "value" block, dividing up by this percentage.

<br>

- **\<podcast:season title="[title of season(string)]">**[(int)]**\</podcast:season>**

Item

(optional | single)

This element allows for identifying which episodes in a podcast are part of a "season", and allowing that season to have a title associate with it. The element's value is an integer identifying the season number.

All attributes are optional.

<br><br>

Expand All @@ -326,7 +333,7 @@ contacted and subsequently changes the value of the element to "no".
<br><br>


## ID's
## IDs

Their can be multiple **\<podcast:id>** elements to indicate a listing on multiple platforms, directories, hosts, apps and services. The "platform" attribute shall be a slug
representing the platform, directory, host, app or service. The slugs will look like this:
Expand Down
7 changes: 6 additions & 1 deletion contributors.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Daniel J. Lewis
Andreas Hubel
Christopher Isene
Todd Cochrane
Adam Curry
@PhoneBoy
Ben Slinger
Martin Mouritzen
Expand All @@ -16,5 +17,9 @@ Matt Basta
Mitch Downey
@Muppet1856
Douglas Kastle

Andy Lehman
Daniel Siebiesiuk
Jon Buda
Justin Jackson
Tyler Lacy
... add your name as you contribute!
2 changes: 1 addition & 1 deletion docs/1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This tag is used to link to a transcript or closed captions file. Multiple tags

`<podcast:transcript url="https://example.com/episode1/transcript.json" type="application/json" language="es" rel="captions" />`

Detailed file format information and example files are [here](transcripts/transcripts.md).
Detailed file format information and example files are [here](../transcripts/transcripts.md).

<br><br>

Expand Down
10 changes: 10 additions & 0 deletions docs/element-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,26 @@ For elements that are included in the official [DTD](https://github.com/Podcasti
3. [Podfriend](https://twitter.com/GoPodfriend/status/1316847938828742656)
4. [Podnews](https://podnews.net/rss)
5. [Podcastindex](https://podcastindex.org)
6. [Castopod](https://podlibre.org/castopod-supports-chapters-and-transcript-tags/)

## Locked `<podcast:locked>`
1. [Buzzsprout](https://www.buzzsprout.com/blog/podcast-locking)
2. [Podnews](https://podnews.net/rss)
3. [Podcastindex](https://podcastindex.org)
4. [Transistor](https://transistor.fm)
5. [Fireside](https://fireside.fm)
6. [PodServe.fm](https://www.podserve.fm)
7. [Castopod](https://podlibre.org/castopod-supports-podcast-locking/)

## Funding `<podcast:funding>`
1. [Buzzsprout](https://www.buzzsprout.com/)
2. [Podfriend](https://twitter.com/GoPodfriend/status/1318663369684123648)
3. [Podverse](https://twitter.com/Podverse/status/1325734448608899072?s=20)
4. [Podcastindex](https://podcastindex.org)
5. [podStation](https://chrome.google.com/webstore/detail/podstation-podcast-player/bpcagekijmfcocgjlnnhpdogbplajjfn)
6. [Transistor](https://transistor.fm)
7. [PodServe.fm](https://www.podserve.fm)
8. [Castopod](https://podlibre.org/publish-your-podcast-on-all-platforms/#podcastindex)

## Chapters `<podcast:chapters>`
1. [Podcast Chapters](https://chaptersapp.com/faq/jsonExport.html)
Expand All @@ -30,6 +39,7 @@ For elements that are included in the official [DTD](https://github.com/Podcasti
5. [Buzzsprout](https://twitter.com/buzzsprout/status/1324425781330796545)
6. [Podverse](https://twitter.com/Podverse/status/1324729288281632771?s=20)
7. [Podcastindex](https://podcastindex.org)
8. [Castopod](https://podlibre.org/castopod-supports-chapters-and-transcript-tags/)

## Soundbites `<podcast:soundbite>`
1. [Buzzsprout](https://www.buzzsprout.com)
Expand Down

0 comments on commit aaae2ff

Please sign in to comment.