kopia lustrzana https://github.com/Podcastindex-org/podcast-namespace
formalize value tag
rodzic
fec7ce5728
commit
e9f91e5efa
98
docs/1.0.md
98
docs/1.0.md
|
@ -508,7 +508,8 @@ Example GUID for feed url `podnews.net/rss`:
|
|||
<podcast:guid>9b024349-ccf0-5f69-a609-6b82873eab3c</podcast:guid>
|
||||
```
|
||||
|
||||
### Guid-enabled fast-follow share links
|
||||
#### Guid-enabled fast-follow share links
|
||||
|
||||
The `podcast:guid` value above enables podcasters to produce a link that can share a podcast on a variety of different platforms.
|
||||
|
||||
The format of the link is `https://(a podcast website link)#fastfollow-(type):(a podcast guid)`
|
||||
|
@ -522,3 +523,98 @@ A working example is https://podnews.net/podcast/i8xe9/listen#fastfollow-podcast
|
|||
When scanned on a mobile phone's camera app, this link will go to the specified podcast website. Behavior of this website is up to the creator: some may use a default homepage, others may sniff the useragent and open a default podcast app on a device. In the working example, above, an iPhone user may be taken to Apple Podcasts; an Android user may be taken to Google Podcasts; and another device will be given a page with a player.
|
||||
|
||||
When scanned on a QR code reader inside a podcast app, like [CurioCaster](https://curiocaster.com/), the app can parse the `podcast:guid` value from the URL, allowing the podcast to be opened within the application.
|
||||
|
||||
|
||||
## Value
|
||||
`<podcast:value>`
|
||||
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 can exist at either the `<channel>` or `<item>` level. When it exists at the `<item>` level, it should be treated as an "override" of whatever is defined at the `<channel>` level.
|
||||
|
||||
This is a complex tag, so implementors are HIGHLY encouraged to read the companion [document](https://github.com/Podcastindex-org/podcast-namespace/blob/main/value/value.md) for a complete understanding of how
|
||||
this tag works and what it is capable of.
|
||||
|
||||
#### Parent
|
||||
`<channel>` or `<item>`
|
||||
|
||||
#### Count
|
||||
Single
|
||||
|
||||
#### Node Value
|
||||
The node value must be one or more `<podcast:valueRecipient>` elements.
|
||||
|
||||
#### Attributes
|
||||
- **type:** (required) This is the service slug of the cryptocurrency or protocol layer.
|
||||
- **method:** (required) This is the transport mechanism that will be used.
|
||||
- **suggested:** (optional) This is an optional suggestion on how much cryptocurrency to send with each payment.
|
||||
|
||||
#### Examples
|
||||
```xml
|
||||
<podcast:value
|
||||
type="lightning"
|
||||
method="keysend"
|
||||
suggested="0.00000005000"
|
||||
></podcast:value>
|
||||
```
|
||||
|
||||
|
||||
## Value Recipient
|
||||
`<podcast:valueRecipient>`
|
||||
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
|
||||
in the `split` attribute.
|
||||
|
||||
This element may only exist within a parent `<podcast:value>` element.
|
||||
|
||||
There is no limit on how many `valueRecipient` elements can be present in a given `<podcast:value>` element.
|
||||
|
||||
This is a complex tag, so implementors are HIGHLY encouraged to read the companion [document](https://github.com/Podcastindex-org/podcast-namespace/blob/main/value/value.md) for a complete understanding of how
|
||||
this tag works and what it is capable of.
|
||||
|
||||
#### Parent
|
||||
`<podcast:value>`
|
||||
|
||||
#### Count
|
||||
Multiple
|
||||
|
||||
#### Node Value
|
||||
This element has no node value.
|
||||
|
||||
#### Attributes
|
||||
- **name** (recommended) A free-form string that designates who or what this recipient is.
|
||||
- **customKey** (optional) The name of a custom record key to send along with the payment.
|
||||
- **customValue** (optional) A custom value to pass along with the payment. This is considered the value that belongs to the `customKey`.
|
||||
- **type** (required) A slug that represents the type of receiving address that will receive the payment.
|
||||
- **address** (required) This denotes the receiving address of the payee.
|
||||
- **split** (required) The number of shares of the payment this recipient will receive.
|
||||
- **fee** (optional) If this attribute is not specified, it is assumed to be false.
|
||||
|
||||
#### Examples
|
||||
```xml
|
||||
<podcast:value type="lightning" method="keysend" suggested="0.00000015000">
|
||||
<podcast:valueRecipient
|
||||
name="Alice (Podcaster)"
|
||||
type="node"
|
||||
address="02d5c1bf8b940dc9cadca86d1b0a3c37fbe39cee4c7e839e33bef9174531d27f52"
|
||||
split="40"
|
||||
/>
|
||||
<podcast:valueRecipient
|
||||
name="Bob (Podcaster)"
|
||||
type="node"
|
||||
address="032f4ffbbafffbe51726ad3c164a3d0d37ec27bc67b29a159b0f49ae8ac21b8508"
|
||||
split="40"
|
||||
/>
|
||||
<podcast:valueRecipient
|
||||
name="Carol (Producer)"
|
||||
type="node"
|
||||
address="02dd306e68c46681aa21d88a436fb35355a8579dd30201581cefa17cb179fc4c15"
|
||||
split="15"
|
||||
/>
|
||||
<podcast:valueRecipient
|
||||
name="Hosting Provider"
|
||||
type="node"
|
||||
address="03ae9f91a0cb8ff43840e3c322c4c61f019d8c1c3cea15a25cfc425ac605e61a4a"
|
||||
split="5"
|
||||
fee="true"
|
||||
/>
|
||||
</podcast:value>
|
||||
```
|
|
@ -1,6 +1,6 @@
|
|||
# The "podcast:value" Specification
|
||||
|
||||
<small>Version 1.3 by Dave Jones - 2021.02.25</small>
|
||||
<small>Version 1.4 by @daveajones, @dergigi - 2021.09.01</small>
|
||||
|
||||
<br>
|
||||
|
||||
|
|
Ładowanie…
Reference in New Issue