mirror
/
podcast-namespace
kopia lustrzana https://github.com/Podcastindex-org/podcast-namespace
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

spacing

pull/294/head
Dave Jones 2021-09-02 10:51:28 -05:00
rodzic 5fde6a9097
commit 506735379e
1 zmienionych plików z 17 dodań i 22 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

39
docs/1.0.md
Wyświetl plik

@ -15,7 +15,7 @@ Anywhere the url of a hyper-text based resource is specified, it must be given a
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Transcript ## Transcript
`<podcast:transcript>`<br><br> `<podcast:transcript>`<br><br>
This tag is used to link to a transcript or closed captions file. Multiple tags can be present for multiple transcript formats. This tag is used to link to a transcript or closed captions file. Multiple tags can be present for multiple transcript formats.
@ -56,7 +56,7 @@ Detailed file format information and example files are [here](../transcripts/tra
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Locked ## Locked
`<podcast:locked>`<br><br> `<podcast:locked>`<br><br>
This tag may be set to `yes` or `no`. The purpose is to tell 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. This tag may be set to `yes` or `no`. The purpose is to tell 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.
@ -84,7 +84,7 @@ This tag may be set to `yes` or `no`. The purpose is to tell other podcast platf
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Funding ## Funding
`<podcast:funding>`<br><br> `<podcast:funding>`<br><br>
This tag lists possible donation/funding links for the podcast. The content of the tag is the recommended string to be used with the link. This tag lists possible donation/funding links for the podcast. The content of the tag is the recommended string to be used with the link.
@ -113,7 +113,7 @@ truncated by aggregators.
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Chapters ## Chapters
`<podcast:chapters>`<br><br> `<podcast:chapters>`<br><br>
Links to an external file (see example file) containing chapter data for the episode. See the [jsonChapters.md](https://github.com/Podcastindex-org/podcast-namespace/blob/main/chapters/jsonChapters.md) Links to an external file (see example file) containing chapter data for the episode. See the [jsonChapters.md](https://github.com/Podcastindex-org/podcast-namespace/blob/main/chapters/jsonChapters.md)
@ -136,7 +136,7 @@ file for a description of the chapter file syntax. And, see the [example.json](h
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Soundbite ## Soundbite
`<podcast:soundbite>`<br><br> `<podcast:soundbite>`<br><br>
Points to one or more soundbites within a podcast episode. The intended use includes episodes previews, discoverability, audiogram generation, episode highlights, etc. It should be assumed that the Points to one or more soundbites within a podcast episode. The intended use includes episodes previews, discoverability, audiogram generation, episode highlights, etc. It should be assumed that the
@ -167,7 +167,7 @@ for the node value or it may be truncated by aggregators.
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Person ## Person
`<podcast:person>`<br><br> `<podcast:person>`<br><br>
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 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
@ -215,7 +215,7 @@ The full taxonomy list is [here](https://github.com/Podcastindex-org/podcast-nam
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Location ## Location
`<podcast:location>`<br><br> `<podcast:location>`<br><br>
This tag is intended to describe the location of editorial focus for a podcast's content (i.e. "what place is this podcast about?"). The tag has many use cases and is one of the more complex ones. You This tag is intended to describe the location of editorial focus for a podcast's content (i.e. "what place is this podcast about?"). The tag has many use cases and is one of the more complex ones. You
@ -250,7 +250,7 @@ way. This value cannot be blank. Please do not exceed `128 characters` for the
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Season ## Season
`<podcast:season>`<br><br> `<podcast:season>`<br><br>
This element allows for identifying which episodes in a podcast are part of a particular "season", with an optional season name attached. This element allows for identifying which episodes in a podcast are part of a particular "season", with an optional season name attached.
@ -288,7 +288,7 @@ Please do not exceed `128 characters` for the name attribute.
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Episode ## Episode
`<podcast:episode>`<br><br> `<podcast:episode>`<br><br>
This element exists largely for compatibility with the `season` tag. But, it also allows for a similar idea to what "name" functions as in that element. This element exists largely for compatibility with the `season` tag. But, it also allows for a similar idea to what "name" functions as in that element.
@ -329,7 +329,7 @@ Please do not exceed `32 characters` for the display attribute.
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Trailer ## Trailer
`<podcast:trailer>`<br><br> `<podcast:trailer>`<br><br>
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 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
@ -371,7 +371,7 @@ be put in the channel to later be matched up with a `<podcast:season>4<podcast:s
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## License ## License
`<podcast:license>`<br><br> `<podcast:license>`<br><br>
This element defines a license that is applied to the audio/video content of a single episode, or the audio/video of the podcast as a whole. Custom licenses must always include a url attribute. Implementors are encouraged This element defines a license that is applied to the audio/video content of a single episode, or the audio/video of the podcast as a whole. Custom licenses must always include a url attribute. Implementors are encouraged
@ -399,11 +399,9 @@ must be a free form abbreviation of the name of the license as you reference it
<podcast:license url="https://example.org/mypodcastlicense/full.pdf">my-podcast-license-v1</podcast:license> <podcast:license url="https://example.org/mypodcastlicense/full.pdf">my-podcast-license-v1</podcast:license>
``` ```
<br><br>
<br><br><br><br><!-- Tag block -->
<br><br><!-- Tag block -->
## Alternate Enclosure ## Alternate Enclosure
`<podcast:alternateEnclosure>`<br><br> `<podcast:alternateEnclosure>`<br><br>
This element is meant to provide different versions of, or companion media to the main `<enclosure>` file. This could be an audio only version of a video podcast to allow apps to switch back and forth between audio/video, This element is meant to provide different versions of, or companion media to the main `<enclosure>` file. This could be an audio only version of a video podcast to allow apps to switch back and forth between audio/video,
@ -473,11 +471,9 @@ to allow for file integrity checking.
</podcast:alternateEnclosure> </podcast:alternateEnclosure>
``` ```
<br><br>
<br><br><br><br><!-- Tag block -->
<br><br><!-- Tag block -->
## Source ## Source
`<podcast:source>`<br><br> `<podcast:source>`<br><br>
This element defines a uri location for a `<podcast:alternateEnclosure>` media file. It is meant to be used as a child of the `<podcast:alternateEnclosure>` element. At least one `<podcast:source>` element must be This element defines a uri location for a `<podcast:alternateEnclosure>` media file. It is meant to be used as a child of the `<podcast:alternateEnclosure>` element. At least one `<podcast:source>` element must be
@ -505,7 +501,7 @@ present within every `<podcast:alternateEnclosure>` element.
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Integrity ## Integrity
`<podcast:integrity>`<br><br> `<podcast:integrity>`<br><br>
This element defines a method of verifying integrity of the media given either an [SRI-compliant integrity string](https://www.w3.org/TR/SRI/) (preferred) or a base64 encoded PGP signature. This element is optional within a This element defines a method of verifying integrity of the media given either an [SRI-compliant integrity string](https://www.w3.org/TR/SRI/) (preferred) or a base64 encoded PGP signature. This element is optional within a
@ -532,7 +528,7 @@ This element defines a method of verifying integrity of the media given either a
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Guid ## Guid
`<podcast:guid>`<br><br> `<podcast:guid>`<br><br>
This element is used to declare a unique, global identifier for a podcast. The value is a UUIDv5, and is easily generated from the RSS feed url, with the **protocol scheme and trailing slashes stripped off**, combined with a unique "podcast" namespace This element is used to declare a unique, global identifier for a podcast. The value is a UUIDv5, and is easily generated from the RSS feed url, with the **protocol scheme and trailing slashes stripped off**, combined with a unique "podcast" namespace
@ -587,7 +583,7 @@ Example GUID for feed url `podnews.net/rss`:
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Value ## Value
`<podcast:value>`<br><br> `<podcast:value>`<br><br>
This element designates the cryptocurrency or payment layer that will be used, the transport method for transacting the payments, and a suggested amount denominated in the given cryptocurrency. This element designates the cryptocurrency or payment layer that will be used, the transport method for transacting the payments, and a suggested amount denominated in the given cryptocurrency.
@ -620,10 +616,9 @@ this tag works and what it is capable of.
></podcast:value> ></podcast:value>
``` ```
<br><br>
<br><br><!-- Tag block --> <br><br><br><br><!-- Tag block -->
## Value Recipient ## Value Recipient
`<podcast:valueRecipient>`<br><br> `<podcast:valueRecipient>`<br><br>
The `valueRecipient` tag designates various destinations for payments to be sent to during consumption of the enclosed media. Each recipient is considered to receive a "split" of the total payment according to the number of shares given The `valueRecipient` tag designates various destinations for payments to be sent to during consumption of the enclosed media. Each recipient is considered to receive a "split" of the total payment according to the number of shares given