kopia lustrzana https://github.com/Podcastindex-org/podcast-namespace
Merge pull request #1 from theDanielJLewis/rename-tag-files
Renamed tag files for consistency and URI conventionspull/707/head
Daniel J. Lewis
GitHub
commit
f789fa3174
19
docs/1.0.md
19
docs/1.0.md
|
|
@ -21,7 +21,6 @@ Each tag below exists in the podcast namespace within the specified parent. All
|
|||
explicitly specified as optional. Anywhere the url of a hyper-text based resource is specified, it must be given as
|
||||
`https:` and not `http:`.
|
||||
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Transcript](tags/transcript.md)
|
||||
|
|
@ -35,23 +34,23 @@ explicitly specified as optional. Anywhere the url of a hyper-text based resourc
|
|||
- [Episode](tags/episode.md)
|
||||
- [Trailer](tags/trailer.md)
|
||||
- [License](tags/license.md)
|
||||
- [Alternate Enclosure](tags/alternateEnclosure.md)
|
||||
- [Alternate Enclosure](tags/alternate-enclosure.md)
|
||||
- [Source](tags/source.md)
|
||||
- [Integrity](tags/integrity.md)
|
||||
- [Guid](tags/guid.md)
|
||||
- [Value](tags/value.md)
|
||||
- [Value Recipient](tags/valueRecipient.md)
|
||||
- [Value Recipient](tags/value-recipient.md)
|
||||
- [Medium](tags/medium.md)
|
||||
- [Images](tags/images.md)
|
||||
- [Live Item](tags/liveItem.md)
|
||||
- [Content Link](tags/contentLink.md)
|
||||
- [Social Interact](tags/socialInteract.md)
|
||||
- [Live Item](tags/live-item.md)
|
||||
- [Content Link](tags/content-link.md)
|
||||
- [Social Interact](tags/social-interact.md)
|
||||
- [Block](tags/block.md)
|
||||
- [Txt](tags/txt.md)
|
||||
- [Remote Item](tags/remoteItem.md)
|
||||
- [Remote Item](tags/remote-item.md)
|
||||
- [Podroll](tags/podroll.md)
|
||||
- [Update Frequency](tags/updateFrequency.md)
|
||||
- [Update Frequency](tags/update-frequency.md)
|
||||
- [Podping](tags/podping.md)
|
||||
- [Value Time Split](tags/valueTimeSplit.md)
|
||||
- [Value Time Split](tags/value-time-split.md)
|
||||
- [Chat](tags/chat.md)
|
||||
- [Publisher](tags/publisher.md)
|
||||
- [Publisher](tags/publisher.md)
|
||||
|
|
|
|||
|
|
@ -2,15 +2,15 @@
|
|||
|
||||
`<podcast:chat>`
|
||||
|
||||
This element allows a podcaster to attach information to either the `<channel>`, `<item>` or [`<podcast:liveItem>`](liveItem.md) about where the "official" chat for either the podcast or a specific episode or live event is to be found. Just like [`<podcast:socialInteract>`](socialInteract.md) functions for social media, the `<podcast:chat>` tag will function for ephemeral chat. There are many protocols in use across the internet for chat based communication. This tag is meant to be flexible enough to adapt to whichever protocol the podcaster wants to use.
|
||||
This element allows a podcaster to attach information to either the `<channel>`, `<item>` or [`<podcast:liveItem>`](live-item.md) about where the "official" chat for either the podcast or a specific episode or live event is to be found. Just like [`<podcast:socialInteract>`](social-interact.md) functions for social media, the `<podcast:chat>` tag will function for ephemeral chat. There are many protocols in use across the internet for chat based communication. This tag is meant to be flexible enough to adapt to whichever protocol the podcaster wants to use.
|
||||
|
||||
This element's presence at a particular level governs how it should be treated. If found at the `<item>` or [`<podcast:liveItem>`](liveItem.md) level, this should be treated as the information for that specific episode, overriding what is at the `<channel>` level. If this tag is found at the `<channel>` level, it would be considered the chat for the entire podcast and is recommended to be an "always on" chat room experience.
|
||||
This element's presence at a particular level governs how it should be treated. If found at the `<item>` or [`<podcast:liveItem>`](live-item.md) level, this should be treated as the information for that specific episode, overriding what is at the `<channel>` level. If this tag is found at the `<channel>` level, it would be considered the chat for the entire podcast and is recommended to be an "always on" chat room experience.
|
||||
|
||||
If a podcast has an "always on" style chat service it is recommended to link that at the `<channel>` level and do not use the `<podcast:chat>` tag at the `<item>` or [`<podcast:liveItem>`](liveItem.md) level.
|
||||
If a podcast has an "always on" style chat service it is recommended to link that at the `<channel>` level and do not use the `<podcast:chat>` tag at the `<item>` or [`<podcast:liveItem>`](live-item.md) level.
|
||||
|
||||
### Parent
|
||||
|
||||
`<channel>` or `<item>` or [`<podcast:liveItem>`](liveItem.md)
|
||||
`<channel>` or `<item>` or [`<podcast:liveItem>`](live-item.md)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
|
|||
|
|
@ -4,11 +4,11 @@
|
|||
|
||||
The `contentLink` tag is used to indicate that the content being delivered by the parent element can be found at an external location instead of, or in addition to, the tag itself within an app. In most instances it is used as a fallback link for the user to use when the app itself can't handle a certain content delivery directly.
|
||||
|
||||
For instance, perhaps a podcast feed specifies a [`<podcast:liveItem>`](liveItem.md) to deliver a live stream to apps. The feed may also give a `<podcast:contentLink>` pointing to YouTube and Twitch versions of the live stream as well, just in case the listener uses an app that doesn't fully support live streaming content.
|
||||
For instance, perhaps a podcast feed specifies a [`<podcast:liveItem>`](live-item.md) to deliver a live stream to apps. The feed may also give a `<podcast:contentLink>` pointing to YouTube and Twitch versions of the live stream as well, just in case the listener uses an app that doesn't fully support live streaming content.
|
||||
|
||||
### Parent
|
||||
|
||||
`<item>` or [`<podcast:liveItem>`](liveItem.md)
|
||||
`<item>` or [`<podcast:liveItem>`](live-item.md)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -30,7 +30,7 @@ The node value is a free-form string meant to explain to the user where this con
|
|||
<podcast:contentLink href="https://www.youtube.com/watch?v=8c7HWZROxD8">Watch this episode on YouTube!</podcast:contentLink>
|
||||
```
|
||||
|
||||
(under [`<podcast:liveItem>`](liveItem.md))
|
||||
(under [`<podcast:liveItem>`](live-item.md))
|
||||
|
||||
```xml
|
||||
<podcast:contentLink href="https://youtube.com/blahblah/livestream">Live on YouTube!</podcast:contentLink>
|
||||
|
|
@ -6,7 +6,7 @@ This tag lists possible donation/funding links for the podcast. The content of t
|
|||
|
||||
### Parent
|
||||
|
||||
`<channel>`, `<item>` or [`<podcast:liveItem>`](liveItem.md)
|
||||
`<channel>`, `<item>` or [`<podcast:liveItem>`](live-item.md)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
|
||||
`<podcast:integrity>`
|
||||
|
||||
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 [`<podcast:alternateEnclosure>`](alternateEnclosure.md) element. It allows to ensure that the file has not been tampered with.
|
||||
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 [`<podcast:alternateEnclosure>`](alternate-enclosure.md) element. It allows to ensure that the file has not been tampered with.
|
||||
|
||||
### Parent
|
||||
|
||||
[`<podcast:alternateEnclosure>`](alternateEnclosure.md)
|
||||
[`<podcast:alternateEnclosure>`](alternate-enclosure.md)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ The node value is a string denoting one of the following possible values:
|
|||
- `audiobook` - Specific types of audio with one item per feed, or where items represent chapters within the book.
|
||||
- `newsletter` - Describes a feed of curated written articles. Newsletter articles now sometimes have an spoken version audio enclosure attached.
|
||||
- `blog` - Describes a feed of informally written articles. Similar to `newsletter` but more informal as in a traditional blog platform style.
|
||||
- `publisher` - Describes a feed that links to other feeds a publisher owns using the [`<podcast:remoteItem>`](remoteItem.md) element. To understand the structure of how "publisher" feeds work, please see the dedicated document [here](../../publishers/publishers.md) and the [`<podcast:publisher>`](publisher.md) tag [here](./publisher.md).
|
||||
- `publisher` - Describes a feed that links to other feeds a publisher owns using the [`<podcast:remoteItem>`](remote-item.md) element. To understand the structure of how "publisher" feeds work, please see the dedicated document [here](../../publishers/publishers.md) and the [`<podcast:publisher>`](publisher.md) tag [here](./publisher.md).
|
||||
- `course` - A feed of training material (audio or video courses) with each item being a session or chapter of the course or conference track.
|
||||
|
||||
### List Mediums
|
||||
|
|
@ -34,9 +34,9 @@ In addition to the above mediums, each medium also has a counterpart "list" vari
|
|||
|
||||
There is also a dedicated list medium for mixed content:
|
||||
|
||||
- `mixed` - This list medium type describes a feed of [`<podcast:remoteItem>`](remoteItem.md)'s that point to different remote medium types. For instance, a single list feed might point to music, podcast and audiobook items in other feeds. An example would be a personal consumption history feed.
|
||||
- `mixed` - This list medium type describes a feed of [`<podcast:remoteItem>`](remote-item.md)'s that point to different remote medium types. For instance, a single list feed might point to music, podcast and audiobook items in other feeds. An example would be a personal consumption history feed.
|
||||
|
||||
A "list" medium feed should not be expected to have regular `<item>`'s,[`<podcast:liveItem>`](liveItem.md)'s, or any future similar new item type. Rather, a "List" feed is intended to exclusively contain one or more [`<podcast:remoteItem>`](remoteItem.md)'s, allowing one to reference a feed by its [`<podcast:guid>`](guid.md) and the guid of an item.
|
||||
A "list" medium feed should not be expected to have regular `<item>`'s,[`<podcast:liveItem>`](live-item.md)'s, or any future similar new item type. Rather, a "List" feed is intended to exclusively contain one or more [`<podcast:remoteItem>`](remote-item.md)'s, allowing one to reference a feed by its [`<podcast:guid>`](guid.md) and the guid of an item.
|
||||
|
||||
### Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Single
|
|||
|
||||
### Node value
|
||||
|
||||
The node value must be one or more [`<podcast:remoteItem>`](remoteItem.md) elements.
|
||||
The node value must be one or more [`<podcast:remoteItem>`](remote-item.md) elements.
|
||||
|
||||
### Example
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
`<podcast:publisher>`
|
||||
|
||||
This element allows a podcast feed to link to it's "publisher feed" parent. This is useful when a parent publishing entity wants to attest ownership over all of the podcast feeds it owns/publishes. This element must contain exactly one `<podcast:remoteItem medium="publisher">` element pointing to the publisher feed. For widest compatibility, it is highly recommended to use the `feedUrl` attribute of the [`<podcast:remoteItem>`](remoteItem.md) element in this capacity.
|
||||
This element allows a podcast feed to link to it's "publisher feed" parent. This is useful when a parent publishing entity wants to attest ownership over all of the podcast feeds it owns/publishes. This element must contain exactly one `<podcast:remoteItem medium="publisher">` element pointing to the publisher feed. For widest compatibility, it is highly recommended to use the `feedUrl` attribute of the [`<podcast:remoteItem>`](remote-item.md) element in this capacity.
|
||||
|
||||
For complete implementation details regarding publisher feeds and how to create them, please see the full publisher feed [documentation](../../publishers/publishers.md) and the `publisher` medium [here](./medium.md#medium).
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Using the `feedGuid` attribute is the preferred way to address a remote feed sin
|
|||
|
||||
### Parent
|
||||
|
||||
`<channel>` or [`<podcast:podroll>`](podroll.md) or [`<podcast:valueTimeSplit>`](valueTimeSplit.md) or [`<podcast:publisher>`](publisher.md)
|
||||
`<channel>` or [`<podcast:podroll>`](podroll.md) or [`<podcast:valueTimeSplit>`](value-time-split.md) or [`<podcast:publisher>`](publisher.md)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
@ -2,11 +2,11 @@
|
|||
|
||||
`<podcast:source>`
|
||||
|
||||
This element defines a uri location for a [`<podcast:alternateEnclosure>`](alternateEnclosure.md) media file. It is meant to be used as a child of the [`<podcast:alternateEnclosure>`](alternateEnclosure.md) element. At least one `<podcast:source>` element must be present within every [`<podcast:alternateEnclosure>`](alternateEnclosure.md) element.
|
||||
This element defines a uri location for a [`<podcast:alternateEnclosure>`](alternate-enclosure.md) media file. It is meant to be used as a child of the [`<podcast:alternateEnclosure>`](alternate-enclosure.md) element. At least one `<podcast:source>` element must be present within every [`<podcast:alternateEnclosure>`](alternate-enclosure.md) element.
|
||||
|
||||
### Parent
|
||||
|
||||
[`<podcast:alternateEnclosure>`](alternateEnclosure.md)
|
||||
[`<podcast:alternateEnclosure>`](alternate-enclosure.md)
|
||||
|
||||
### Count
|
||||
|
||||
|
|
|
|||
|
|
@ -2,15 +2,15 @@
|
|||
|
||||
`<podcast:valueTimeSplit>`
|
||||
|
||||
This element allows different value splits for a certain period of time. It is a combination of the concept of [`<podcast:soundbite>`](soundbite.md) and [`<podcast:remoteItem>`](remoteItem.md) where a start time and a duration is supplied with alternative value recipients. The alternative value recipients are not required to be remote, as the recipients may not have an RSS feed/item of their own to reference.
|
||||
This element allows different value splits for a certain period of time. It is a combination of the concept of [`<podcast:soundbite>`](soundbite.md) and [`<podcast:remoteItem>`](remote-item.md) where a start time and a duration is supplied with alternative value recipients. The alternative value recipients are not required to be remote, as the recipients may not have an RSS feed/item of their own to reference.
|
||||
|
||||
The `<podcast:valueTimeSplit>` element allows time-based changes of value recipient information during playback of a feed's enclosure content.
|
||||
|
||||
This can either contain one or more [`<podcast:valueRecipient>`](valueRecipient.md) tags _or_ exactly one [`<podcast:remoteItem>`](remoteItem.md) tag. If a [`<podcast:remoteItem>`](remoteItem.md) tag is present, the `remotePercentage` attribute can be defined to control how much the remote value block's [`<podcast:valueRecipient>`](valueRecipient.md) tags will receive as a whole on top of the default, non-fee [`<podcast:valueRecipient>`](valueRecipient.md) tags.
|
||||
This can either contain one or more [`<podcast:valueRecipient>`](value-recipient.md) tags _or_ exactly one [`<podcast:remoteItem>`](remote-item.md) tag. If a [`<podcast:remoteItem>`](remote-item.md) tag is present, the `remotePercentage` attribute can be defined to control how much the remote value block's [`<podcast:valueRecipient>`](value-recipient.md) tags will receive as a whole on top of the default, non-fee [`<podcast:valueRecipient>`](value-recipient.md) tags.
|
||||
|
||||
If the remote value block contains any `<podcast:valueTimeSplit>` tags, they should be ignored even if the `remoteStartTime` indicates it's in a position that would invoke them. When referencing a remote value block, only the root level block splits should be used and any `<podcast:valueTimeSplit>` children are to be ignored.
|
||||
|
||||
Fees from the default [`<podcast:valueRecipient>`](valueRecipient.md) tags should remain to be calculated before anything is taken out from `<podcast:valueTimeSplit>`.
|
||||
Fees from the default [`<podcast:valueRecipient>`](value-recipient.md) tags should remain to be calculated before anything is taken out from `<podcast:valueTimeSplit>`.
|
||||
|
||||
### Parent
|
||||
|
||||
|
|
@ -22,14 +22,14 @@ Multiple
|
|||
|
||||
### Node Value
|
||||
|
||||
A single [`<podcast:remoteItem>`](remoteItem.md) element OR one or more [`<podcast:valueRecipient>`](valueRecipient.md) elements.
|
||||
A single [`<podcast:remoteItem>`](remote-item.md) element OR one or more [`<podcast:valueRecipient>`](value-recipient.md) elements.
|
||||
|
||||
### Attributes
|
||||
|
||||
- `startTime` (required) - The time, in seconds, to stop using the currently active value recipient information and start using the value recipient information contained in this element.
|
||||
- `duration` (required) - How many seconds the playback app should use this element's value recipient information before switching back to the value recipient information of the parent feed.
|
||||
- `remoteStartTime` (optional) - The time in the remote item where the value split begins. Allows the timestamp to be set correctly in value metadata. If not defined, defaults to 0.
|
||||
- `remotePercentage` (optional) - The percentage of the payment the remote recipients will receive if a [`<podcast:remoteItem>`](remoteItem.md) is present. If not defined, defaults to 100. If the value is less than 0, 0 is assumed. If the value is greater than 100, 100 is assumed.
|
||||
- `remotePercentage` (optional) - The percentage of the payment the remote recipients will receive if a [`<podcast:remoteItem>`](remote-item.md) is present. If not defined, defaults to 100. If the value is less than 0, 0 is assumed. If the value is greater than 100, 100 is assumed.
|
||||
|
||||
### Example (Remote Item)
|
||||
|
||||
|
|
@ -18,7 +18,7 @@ Multiple
|
|||
|
||||
### Node Value
|
||||
|
||||
The node value must be one or more [`<podcast:valueRecipient>`](valueRecipient.md) elements.
|
||||
The node value must be one or more [`<podcast:valueRecipient>`](value-recipient.md) elements.
|
||||
|
||||
### Attributes
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue