kopia lustrzana https://github.com/Podcastindex-org/podcast-namespace
Add highlighting hint to code blocks
Alecks Gates
rodzic
321f037e21
commit
adcf454c01
22
README.md
22
README.md
|
|
@ -152,7 +152,7 @@ The following tags should be considered purely as work in progress proposals. T
|
|||
|
||||
<b>
|
||||
|
||||
```
|
||||
```xml
|
||||
<podcast:trailer
|
||||
pubdate="[date of release(RFC 2822)]"
|
||||
url="[uri of audio/video file(string)]"
|
||||
|
|
@ -179,12 +179,12 @@ This element is used to define the location of an audio or video file to be used
|
|||
- `season` (optional) If this attribute is present it specifies that this trailer is for a particular season number.
|
||||
|
||||
Example:
|
||||
```
|
||||
```xml
|
||||
<podcast:trailer pubdate="Thu, 01 Apr 2021 08:00:00 EST" url="https://example.org/trailers/teaser" length="12345678" type="audio/mp3">Coming April 1st, 2021</podcast:trailer>
|
||||
```
|
||||
|
||||
Example with Season Linkage:
|
||||
```
|
||||
```xml
|
||||
<podcast:trailer pubdate="Thu, 01 Apr 2021 08:00:00 EST" url="https://example.org/trailers/season4teaser" length="12345678" type="video/mp4" season="4">Season 4: Race for the Whitehouse</podcast:trailer>
|
||||
|
||||
(combined with)
|
||||
|
|
@ -200,7 +200,7 @@ Example with Season Linkage:
|
|||
|
||||
<b>
|
||||
|
||||
```
|
||||
```xml
|
||||
<podcast:license
|
||||
url="[https://urlofdetailledlicense]"
|
||||
>
|
||||
|
|
@ -220,7 +220,7 @@ should be a reference to a slug defined in the [license slugs](licenseslugs.txt)
|
|||
- `url` (optional) This is a url that points to the full license details for this license.
|
||||
|
||||
Example:
|
||||
```
|
||||
```xml
|
||||
<podcast:license url="https://creativecommons.org/licenses/by/4.0/">cc-by-4.0</podcast:license>
|
||||
```
|
||||
|
||||
|
|
@ -232,7 +232,7 @@ Example:
|
|||
|
||||
<b>
|
||||
|
||||
```
|
||||
```xml
|
||||
<podcast:recommendations
|
||||
url="[url to json file(string)]"
|
||||
type="application/json"
|
||||
|
|
@ -255,12 +255,12 @@ This is a complex tag. The full documentation is [here](https://github.com/Podc
|
|||
read that document to understand and comment on this proposal.
|
||||
|
||||
Example:
|
||||
```
|
||||
```xml
|
||||
<podcast:recommendations url="https://domain.tld/recommendation?guid=1234" type="application/json" />
|
||||
```
|
||||
|
||||
Example:
|
||||
```
|
||||
```xml
|
||||
<podcast:recommendations url="https://domain.tld/recommendation?guid=1234" type="application/json" language="en">Some other cool podcasts</podcast:recommendations>
|
||||
```
|
||||
|
||||
|
|
@ -271,7 +271,7 @@ Example:
|
|||
|
||||
<b>
|
||||
|
||||
```
|
||||
```xml
|
||||
<podcast:alternateEnclosure
|
||||
type="[mime type]"
|
||||
length="[(int)]"
|
||||
|
|
@ -301,7 +301,7 @@ This is a complex tag. The full documentation is [here](https://github.com/Podc
|
|||
read that document to understand and comment on this proposal.
|
||||
|
||||
Example:
|
||||
```
|
||||
```xml
|
||||
<enclosure url="https://best-podcast.com/file-0.mp3" length="43200000" type="audio/mpeg" />
|
||||
|
||||
<podcast:alternateEnclosure type="audio/mpeg" length="43200000" bitrate="128000" default="true" title="Standard">
|
||||
|
|
@ -326,7 +326,7 @@ Example:
|
|||
```
|
||||
|
||||
Example:
|
||||
```
|
||||
```xml
|
||||
<podcast:alternateEnclosure type="audio/mpeg" length="2490970" bitrate="160707.74">
|
||||
<podcast:source uri="https://best-podcast.com/file-0.mp3" />
|
||||
<podcast:source uri="ipfs://QmdwGqd3d2gFPGeJNLLCshdiPert45fMu84552Y4XHTy4y" />
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ The chapters object is a simple JSON object with only 2 required properties:
|
|||
|
||||
The "chapter" object takes this basic form:
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"startTime": 94,
|
||||
"title": "Donation Segment"
|
||||
|
|
@ -62,7 +62,7 @@ There is only one required attribute:
|
|||
|
||||
The "location" object takes this basic form:
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"name": "Eiffel Tower, Paris",
|
||||
"geo": "geo:48.858093,2.294694"
|
||||
|
|
@ -87,7 +87,7 @@ There are two required attributes:
|
|||
|
||||
Here is what a very basic chapters file may look like:
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"version": "1.1.0",
|
||||
"chapters":
|
||||
|
|
@ -144,7 +144,7 @@ In this more robust example, we can bring in more meta-data about the podcast ep
|
|||
context for something like an embedded HTML5 player on a website. Also there is an example of a "silent" chapter that has no presence in the visible
|
||||
chapter list, but allows for different artwork to be shown:
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"version": "1.1.0",
|
||||
"author": "John Doe",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ A wholistic RSS namespace for podcasting that is meant to synthesize the fragmen
|
|||
|
||||
The namespace for this extension is `https://podcastindex.org/namespace/1.0`. Clients which recognize this namespace must also recognize `https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md` as identical. The suggested tag prefix for use in XML is `podcast`, but clients should support alternate prefixes for this namespace. If your application generates RSS feeds and you implement one or more elements below, you will need to link this DTD in your XML:
|
||||
|
||||
```
|
||||
```xml
|
||||
<rss version="2.0" xmlns:podcast="https://podcastindex.org/namespace/1.0">
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ This, therefore, means that the `<podcast:location>` tag is complex and has a nu
|
|||
|
||||
### Structure
|
||||
|
||||
```
|
||||
```xml
|
||||
<podcast:location
|
||||
geo="[geo URI]"
|
||||
osm="[OSM type][OSM id](#OSM revision)"
|
||||
|
|
@ -110,7 +110,7 @@ Podcast hosts may also wish to remind podcast publishers to always be cautious a
|
|||
|
||||
For a podcast that is talking about the Eiffel Tower, but actually made in Birmingham, Alabama, this is what the specification would suggest:
|
||||
|
||||
```
|
||||
```xml
|
||||
<podcast:location
|
||||
geo="geo:48.858093,2.294694"
|
||||
osm="W5013364"
|
||||
|
|
@ -119,7 +119,7 @@ For a podcast that is talking about the Eiffel Tower, but actually made in Birmi
|
|||
|
||||
For a podcast that is set in Gitmo Nation, a nickname used by the show for the United States of America:
|
||||
|
||||
```
|
||||
```xml
|
||||
<podcast:location
|
||||
geo="geo:39.7837304,-100.445882;u=3900000"
|
||||
osm="R148838"
|
||||
|
|
@ -131,13 +131,13 @@ includes a more accurate bounding box and geoJSON.
|
|||
|
||||
For a podcast that is about Hogwarts (a fictional location), the `geo` and `osm` must not be entered:
|
||||
|
||||
```
|
||||
<podcast:location>Hogwarts"</podcast:location>
|
||||
```xml
|
||||
<podcast:location>Hogwarts</podcast:location>
|
||||
```
|
||||
|
||||
For a podcast from Tesla upon landing on Mars:
|
||||
|
||||
```
|
||||
```xml
|
||||
<podcast:location geo="geo:37.786971,-122.399677;crs=Mars-2031">Tesla Base 3</podcast:location>
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -55,10 +55,10 @@ The recommendations object is a simple JSON object with 2 required properties:
|
|||
|
||||
The "recommendation" object takes this basic form:
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"type": "page",
|
||||
"title": "History of podcasting",
|
||||
"title": "History of podcasting",
|
||||
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png",
|
||||
"url": "https://en.wikipedia.org/wiki/History_of_podcasting"
|
||||
}
|
||||
|
|
@ -85,14 +85,14 @@ There are 4 required attributes:
|
|||
|
||||
Here is what a very basic recommendations file may look like:
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"version": "1.0",
|
||||
"recommendations":
|
||||
[
|
||||
{
|
||||
"type": "page",
|
||||
"title": "History of podcasting",
|
||||
"title": "History of podcasting",
|
||||
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png",
|
||||
"url": "https://en.wikipedia.org/wiki/History_of_podcasting"
|
||||
},
|
||||
|
|
@ -127,7 +127,7 @@ Here is what a very basic recommendations file may look like:
|
|||
|
||||
## More complex example
|
||||
|
||||
```
|
||||
```json
|
||||
{
|
||||
"version": "1.0",
|
||||
"title": "Podnews podcasting news",
|
||||
|
|
@ -138,7 +138,7 @@ Here is what a very basic recommendations file may look like:
|
|||
"displayStartTime": 0.0,
|
||||
"displayDuration": 120.0,
|
||||
"type": "page",
|
||||
"title": "History of podcasting",
|
||||
"title": "History of podcasting",
|
||||
"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e7/Podcasts_%28iOS%29.svg/440px-Podcasts_%28iOS%29.svg.png",
|
||||
"url": "https://en.wikipedia.org/wiki/History_of_podcasting",
|
||||
"relevance": 0.8
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ designed to serve as an accessibility aid and provide searchable episode content
|
|||
- `<p>`: Content of monologue
|
||||
|
||||
#### Snippet:
|
||||
```
|
||||
```html
|
||||
<cite>Kevin:</cite>
|
||||
<time>0:00</time>
|
||||
<p>We have an update planned where we would like to give the ability to upload an artwork file for these videos</p>
|
||||
|
|
@ -44,7 +44,7 @@ The JSON representation is a flexible format that accomodates various degrees of
|
|||
- `<body>`: Dialogue content
|
||||
|
||||
#### Snippet:
|
||||
```
|
||||
```json
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"segments": [
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ Currently, there can be only a single copy of this element at each level.
|
|||
<br>
|
||||
|
||||
#### Structure:
|
||||
```
|
||||
```xml
|
||||
<podcast:value
|
||||
type="[cryptocurrency or layer(string)]"
|
||||
method="[payment transport(string)]"
|
||||
|
|
@ -107,7 +107,7 @@ exists at the `<item>` level, it is intended to override the channel level tag f
|
|||
|
||||
#### Example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<podcast:value
|
||||
type="lightning"
|
||||
method="keysend"
|
||||
|
|
@ -133,7 +133,7 @@ There is no limit on how many `valueRecipient` elements can be present in a give
|
|||
|
||||
#### Structure:
|
||||
|
||||
```
|
||||
```xml
|
||||
<podcast:valueRecipient
|
||||
name="[name of recipient(string)]"
|
||||
type="[address type(string)]"
|
||||
|
|
@ -192,7 +192,7 @@ The interval payment calculation is:
|
|||
|
||||
To calculate payouts, let's take the following value block as an example:
|
||||
|
||||
```
|
||||
```xml
|
||||
<podcast:value type="lightning" method="keysend" suggested="0.00000015000">
|
||||
<podcast:valueRecipient
|
||||
name="Host"
|
||||
|
|
@ -294,7 +294,7 @@ This is a live, working example of a Lightning keysend value block in production
|
|||
podcast hosts at 49 and 46 shares respectively, a producer working on per episode chapter creation who gets a 5 share, and
|
||||
a single share (effectively 1%) fee to the Podcastindex.org API.
|
||||
|
||||
```
|
||||
```xml
|
||||
<podcast:value type="lightning" method="keysend" suggested="0.00000015000">
|
||||
<podcast:valueRecipient
|
||||
name="Adam Curry (Podcaster)"
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue