diff --git a/docs/tags/alternate-enclosure.md b/docs/tags/alternate-enclosure.md index 874fe24..1ceb51b 100644 --- a/docs/tags/alternate-enclosure.md +++ b/docs/tags/alternate-enclosure.md @@ -20,15 +20,15 @@ The node value must be one or more [``](source.md) elements that ### Attributes -- **type:** (required) Mime type of the media asset. -- **length:** (recommended) Length of the file in bytes. -- **bitrate:** (optional) Average encoding bitrate of the media asset, expressed in bits per second. -- **height:** (optional) Height of the media asset for video formats. -- **lang:** (optional) An [IETF language tag (BCP 47)](https://en.wikipedia.org/wiki/BCP_47) code identifying the language of this media. -- **title:** (optional) A human-readable string identifying the name of the media asset. Should be limited to 32 characters for UX. -- **rel:** (optional) Provides a method of offering and/or grouping together different media elements. If not set, or set to "default", the media will be grouped with the enclosure and assumed to be an alternative to the enclosure's encoding/transport. This attribute can and should be the same for items with the same content encoded by different means. Should be limited to 32 characters for UX. -- **codecs:** (optional) An [RFC 6381](https://tools.ietf.org/html/rfc6381) string specifying the codecs available in this media. -- **default:** (optional) Boolean specifying whether or not the given media is the same as the file from the enclosure element and should be the preferred media element. The primary reason to set this is to offer alternative transports for the enclosure. If not set, this should be assumed to be false. +- `type` **(required)**: Mime type of the media asset. +- `length` (recommended): Length of the file in bytes. +- `bitrate` (optional): Average encoding bitrate of the media asset, expressed in bits per second. +- `height` (optional): Height of the media asset for video formats. +- `lang` (optional): An [IETF language tag (BCP 47)](https://en.wikipedia.org/wiki/BCP_47) code identifying the language of this media. +- `title` (optional): A human-readable string identifying the name of the media asset. Should be limited to 32 characters for UX. +- `rel` (optional): Provides a method of offering and/or grouping together different media elements. If not set, or set to "default", the media will be grouped with the enclosure and assumed to be an alternative to the enclosure's encoding/transport. This attribute can and should be the same for items with the same content encoded by different means. Should be limited to 32 characters for UX. +- `codecs` (optional): An [RFC 6381](https://tools.ietf.org/html/rfc6381) string specifying the codecs available in this media. +- `default` (optional): Boolean specifying whether or not the given media is the same as the file from the enclosure element and should be the preferred media element. The primary reason to set this is to offer alternative transports for the enclosure. If not set, this should be assumed to be false. ### Examples diff --git a/docs/tags/block.md b/docs/tags/block.md index a53f8dd..73c65fd 100644 --- a/docs/tags/block.md +++ b/docs/tags/block.md @@ -22,7 +22,7 @@ Multiple ### Attributes -- **id** (optional) A single entry from the [service slug list](https://github.com/Podcastindex-org/podcast-namespace/blob/main/serviceslugs.txt). +- `id` (optional): A single entry from the [service slug list](https://github.com/Podcastindex-org/podcast-namespace/blob/main/serviceslugs.txt). ### Node value diff --git a/docs/tags/chapters.md b/docs/tags/chapters.md index 21eb99f..c8c3ac3 100644 --- a/docs/tags/chapters.md +++ b/docs/tags/chapters.md @@ -16,8 +16,8 @@ Single ### Attributes -- **url (required):** The URL where the chapters file is located. -- **type (required):** Mime type of file - JSON prefered, 'application/json+chapters'. +- `url` **(required)**: The URL where the chapters file is located. +- `type` **(required)**: Mime type of file - JSON prefered, 'application/json+chapters'. ### Examples diff --git a/docs/tags/chat.md b/docs/tags/chat.md index 7db322a..0dc34f8 100644 --- a/docs/tags/chat.md +++ b/docs/tags/chat.md @@ -18,10 +18,10 @@ Single ### Attributes -- `server` (required) The fqdn of a chat server that serves as the "bootstrap" server to connect to. -- `protocol` (required) The [protocol](../chatprotocols.txt) in use on the server. -- `accountId` (recommended) The account id of the podcaster on the server or platform being connected to. -- `space` (optional) Some chat systems have a notion of a chat "space" or "room" or "topic". This attribute will serve that purpose. +- `server` **(required)**: The fqdn of a chat server that serves as the "bootstrap" server to connect to. +- `protocol` **(required)**: The [protocol](../chatprotocols.txt) in use on the server. +- `accountId` (recommended): The account id of the podcaster on the server or platform being connected to. +- `space` (optional): Some chat systems have a notion of a chat "space" or "room" or "topic". This attribute will serve that purpose. ### Example (IRC): diff --git a/docs/tags/content-link.md b/docs/tags/content-link.md index 5b2e406..4a03cbe 100644 --- a/docs/tags/content-link.md +++ b/docs/tags/content-link.md @@ -20,7 +20,7 @@ The node value is a free-form string meant to explain to the user where this con ### Attributes -- **href** (required) A string that is the uri pointing to content outside of the application. +- `href` **(required)**: A string that is the uri pointing to content outside of the application. ### Examples diff --git a/docs/tags/episode.md b/docs/tags/episode.md index 43c9bc7..0b3a57c 100644 --- a/docs/tags/episode.md +++ b/docs/tags/episode.md @@ -18,7 +18,7 @@ The node value is a decimal number. It is required. ### Attributes -- **display:** (optional) - If this attribute is present, podcast apps and aggregators are encouraged to show its value instead of the purely numerical node value. This attribute is a string. +- `display` (optional): If this attribute is present, podcast apps and aggregators are encouraged to show its value instead of the purely numerical node value. This attribute is a string. The episode numbers are decimal, so numbering such as `100.5` is acceptable if there was a special mini-episode published between two other episodes. In that scenario, the number would help with proper chronological sorting, while the `display` attribute could specify an alternate special "number" (a moniker) to display for the episode in a podcast player app UI. diff --git a/docs/tags/funding.md b/docs/tags/funding.md index c92918c..a49145f 100644 --- a/docs/tags/funding.md +++ b/docs/tags/funding.md @@ -18,7 +18,7 @@ This is a free form string supplied by the creator which they expect to be displ ### Attributes -- **url (required):** The URL to be followed to fund the podcast. +- `url` **(required)**: The URL to be followed to fund the podcast. ### Examples diff --git a/docs/tags/image.md b/docs/tags/image.md index 7a6229c..4648391 100644 --- a/docs/tags/image.md +++ b/docs/tags/image.md @@ -11,13 +11,13 @@ This tag allows for the delivering of images of various sizes and use cases. It Multiple ### Attributes -- href (required): The URL to the media you want to embed. -- alt (recommended): A clear and concise accessibility focused text replacement for the image’s content. -- aspect-ratio (recommended): A ratio value such as 1/1, 16/9, 4/1 following the equivalent [CSS syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio). This allows podcasters to provide multiple art directions for the same media. -- width (recommended): The width of the asset in pixels. -- height (optional): The height of the asset in pixels. -- type (optional): Mime type of the media such as image/jpeg or video/mp4. -- purpose (optional): An unordered set of case-insensitive, space-separated tokens following the equivalent [W3C syntax](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#space-separated-tokens). This value should not exceed 128 characters. This allows podcasters to indicate the suggested uses of this media. +- `href` **(required)**: The URL to the media you want to embed. +- `alt` (recommended): A clear and concise accessibility focused text replacement for the image’s content. +- `aspect-ratio` (recommended): A ratio value such as 1/1, 16/9, 4/1 following the equivalent [CSS syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio). This allows podcasters to provide multiple art directions for the same media. +- `width` (recommended): The width of the asset in pixels. +- `height` (optional): The height of the asset in pixels. +- `type` (optional): Mime type of the media such as image/jpeg or video/mp4. +- `purpose` (optional): An unordered set of case-insensitive, space-separated tokens following the equivalent [W3C syntax](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#space-separated-tokens). This value should not exceed 128 characters. This allows podcasters to indicate the suggested uses of this media. ### Notes The only required attribute is `href`, specifying the url of the asset being delivered. If no further attributes are defined, such as `aspect-ratio` or `purpose`, the image is assumed to be square (1:1). For accessibility, `alt` is also encouraged. diff --git a/docs/tags/images-(deprecated).md b/docs/tags/images-(deprecated).md index c189f91..42e2e44 100644 --- a/docs/tags/images-(deprecated).md +++ b/docs/tags/images-(deprecated).md @@ -16,7 +16,7 @@ Single ### Attributes -- **srcset** (required) A string that denotes each image url followed by a space and the pixel width, with each one separated by a comma. See the example for a clear view of the syntax. +- `srcset` **(required)**: A string that denotes each image url followed by a space and the pixel width, with each one separated by a comma. See the example for a clear view of the syntax. ### Examples diff --git a/docs/tags/integrity.md b/docs/tags/integrity.md index 0ecccd0..90db3cb 100644 --- a/docs/tags/integrity.md +++ b/docs/tags/integrity.md @@ -14,8 +14,8 @@ Single ### Attributes -- **type:** (required) Type of integrity, either "sri" or "pgp-signature". -- **value:** (required) Value of the sri string or base64 encoded pgp signature. +- `type` **(required)**: Type of integrity, either "sri" or "pgp-signature". +- `value` **(required)**: Value of the sri string or base64 encoded pgp signature. ### Examples diff --git a/docs/tags/live-item.md b/docs/tags/live-item.md index e9da51f..cec8cce 100644 --- a/docs/tags/live-item.md +++ b/docs/tags/live-item.md @@ -30,9 +30,9 @@ The function of `` within a live item tag is the same as it is within a re ### Attributes -- **status** (required) A string that must be one of `pending`, `live` or `ended`. -- **start** (required) A string representing an ISO8601 timestamp that denotes the time when the stream is intended to start. -- **end** (recommended) A string representing an ISO8601 timestamp that denotes the time when the stream is intended to end. +- `status` **(required)**: A string that must be one of `pending`, `live` or `ended`. +- `start` **(required)**: A string representing an ISO8601 timestamp that denotes the time when the stream is intended to start. +- `end` (recommended): A string representing an ISO8601 timestamp that denotes the time when the stream is intended to end. The `start` and `end` attributes denote when the live stream "should" start and end. But, real life dictates that those times might not be adhered to. Apps are therefore encouraged not to rely solely on those times as anything more than an approximation. The canonical way to know if a stream has started is with the `status` attribute. If `status` is "live" then the stream has started. diff --git a/docs/tags/location.md b/docs/tags/location.md index 489542b..0977070 100644 --- a/docs/tags/location.md +++ b/docs/tags/location.md @@ -29,12 +29,12 @@ define the actual location parameters. ### Attributes -- **rel:** (recommended) The `rel` attribute can contain one of the following possible values: +- `rel` (recommended): The `rel` attribute can contain one of the following possible values: - `"subject"` (default) - The location refers to what/where the content is about. - `"creator"` - The location refers to where the content was recorded or produced. -- **geo:** (recommended) A latitude and longitude in geoURI form, following [RFC5870](https://datatracker.ietf.org/doc/html/rfc5870) (i.e. "geo:30.2672,97.7431"). -- **osm:** (recommended) The [OpenStreetMap](https://www.openstreetmap.org/#map=13/41.39239/2.14036) identifier of this place. Made by taking the first character of the [OSM object type](https://locationiq.com/glossary/osm-type) (Node, Way, Relation), followed by the ID. (i.e. "R113314") -- **country:** (recommended) A two-letter code for the country, following [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) +- `geo` (recommended): A latitude and longitude in geoURI form, following [RFC5870](https://datatracker.ietf.org/doc/html/rfc5870) (i.e. "geo:30.2672,97.7431"). +- `osm` (recommended): The [OpenStreetMap](https://www.openstreetmap.org/#map=13/41.39239/2.14036) identifier of this place. Made by taking the first character of the [OSM object type](https://locationiq.com/glossary/osm-type) (Node, Way, Relation), followed by the ID. (i.e. "R113314") +- `country` (recommended): A two-letter code for the country, following [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) > [!NOTE] > While all elements are "recommended", **the location tag works best when all elements are populated.** The [implementation document](../examples/location/location.md) goes into more detail. An example location generator (entirely in JavaScript) is [over here](https://jamescridland.github.io/podcast-location-generator/). diff --git a/docs/tags/locked.md b/docs/tags/locked.md index 0841e2e..fd37e1b 100644 --- a/docs/tags/locked.md +++ b/docs/tags/locked.md @@ -18,7 +18,7 @@ The node value must be "yes" or "no". ### Attributes -- **owner (optional):** The owner attribute is an email address that can be used to verify ownership of this feed during move and import operations. This could be a public email or a virtual email address at the hosting provider that redirects to the owner's true email address. +- `owner` (optional): The owner attribute is an email address that can be used to verify ownership of this feed during move and import operations. This could be a public email or a virtual email address at the hosting provider that redirects to the owner's true email address. ### Examples diff --git a/docs/tags/person.md b/docs/tags/person.md index 774ec13..b69b5dd 100644 --- a/docs/tags/person.md +++ b/docs/tags/person.md @@ -36,10 +36,10 @@ This is the full name or alias of the person. This value cannot be blank. Please ### Attributes -- **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 (see below). If `role` is missing then "host" is assumed. -- **group:** (optional) This should be a 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) The url to a relevant resource of information about the person, such as a homepage or third-party profile platform. Please see the [example feed](https://github.com/Podcastindex-org/podcast-namespace/blob/main/example.xml) for possible choices of what to use here. +- `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 (see below). If `role` is missing then "host" is assumed. +- `group` (optional): This should be a 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): The url to a relevant resource of information about the person, such as a homepage or third-party profile platform. Please see the [example feed](https://github.com/Podcastindex-org/podcast-namespace/blob/main/example.xml) for possible choices of what to use here. The `role` and `group` attributes are case-insensitive. So, "Host" is the same as "host", and "Cover Art Designer" is the same as "cover art designer". diff --git a/docs/tags/remote-item.md b/docs/tags/remote-item.md index 418a51c..c68780c 100644 --- a/docs/tags/remote-item.md +++ b/docs/tags/remote-item.md @@ -16,11 +16,11 @@ Multiple ### Attributes -- **feedGuid** (required) The [``](guid.md) of the remote feed being pointed to. -- **feedUrl** (optional) The url of the remote feed being pointed to. -- **itemGuid** (optional) If this remote item element is intended to point to an `` in the remote feed, this attribute should contain the value of the `` of that ``. -- **medium** (optional) If the feed being pointed to is not of medium type 'podcast', this attribute should contain it's [``](medium.md) type from the [list](./medium.md#medium) of types available in this document. The reason this is helpful is to give the app a heads up on what type of data this is expected to be since that may affect the way it approaches fetch and display. -- **title** (optional) A string that represents the title of the remote item. The purpose of this attribute is to give a hint to apps so that they can display the title without having to do a remote lookup. +- `feedGuid` **(required)**: The [``](guid.md) of the remote feed being pointed to. +- `feedUrl` (optional): The url of the remote feed being pointed to. +- `itemGuid` (optional): If this remote item element is intended to point to an `` in the remote feed, this attribute should contain the value of the `` of that ``. +- `medium` (optional): If the feed being pointed to is not of medium type 'podcast', this attribute should contain it's [``](medium.md) type from the [list](./medium.md#medium) of types available in this document. The reason this is helpful is to give the app a heads up on what type of data this is expected to be since that may affect the way it approaches fetch and display. +- `title` (optional): A string that represents the title of the remote item. The purpose of this attribute is to give a hint to apps so that they can display the title without having to do a remote lookup. ### Examples diff --git a/docs/tags/season.md b/docs/tags/season.md index 8388b1b..c3f0055 100644 --- a/docs/tags/season.md +++ b/docs/tags/season.md @@ -18,7 +18,7 @@ The node value is an integer, and represents the season "number". It is required ### Attributes -- **name:** (optional) - This is the "name" of the season. If this attribute is present, applications are free to **not** show the season number to the end user, and may use it simply for chronological sorting and grouping purposes. +- `name` (optional): This is the "name" of the season. If this attribute is present, applications are free to **not** show the season number to the end user, and may use it simply for chronological sorting and grouping purposes. Please do not exceed `128 characters` for the name attribute. diff --git a/docs/tags/social-interact.md b/docs/tags/social-interact.md index ba93c8f..545f273 100644 --- a/docs/tags/social-interact.md +++ b/docs/tags/social-interact.md @@ -18,11 +18,11 @@ Multiple ### Attributes -- **protocol** (required) The [protocol](https://github.com/Podcastindex-org/podcast-namespace/blob/main/socialprotocols.txt) in use for interacting with the comment root post. -- **uri** (required) The uri/url of root post comment. -- **accountId** (recommended) The account id (on the commenting platform) of the account that created this root post. -- **accountUrl** (optional) The public url (on the commenting platform) of the account that created this root post. -- **priority** (optional) When multiple socialInteract tags are present, this integer gives order of priority. A lower number means higher priority. +- `protocol` **(required)**: The [protocol](https://github.com/Podcastindex-org/podcast-namespace/blob/main/socialprotocols.txt) in use for interacting with the comment root post. +- `uri` **(required)**: The uri/url of root post comment. +- `accountId` (recommended): The account id (on the commenting platform) of the account that created this root post. +- `accountUrl` (optional): The public url (on the commenting platform) of the account that created this root post. +- `priority` (optional): When multiple socialInteract tags are present, this integer gives order of priority. A lower number means higher priority. Example (simple): diff --git a/docs/tags/soundbite.md b/docs/tags/soundbite.md index 0d31caf..e40df08 100644 --- a/docs/tags/soundbite.md +++ b/docs/tags/soundbite.md @@ -18,8 +18,8 @@ This is a free form string from the podcast creator to specify a title for the s ### Attributes -- **startTime (required):** The time where the soundbite begins -- **duration (required):** How long is the soundbite (recommended between 15 and 120 seconds) +- `startTime` **(required)**: The time where the soundbite begins +- `duration` **(required)**: How long is the soundbite (recommended between 15 and 120 seconds) ### Examples diff --git a/docs/tags/source.md b/docs/tags/source.md index 9a4cff4..3907b91 100644 --- a/docs/tags/source.md +++ b/docs/tags/source.md @@ -14,8 +14,8 @@ Multiple ### Attributes -- **uri:** (required) This is the uri where the media file resides. -- **contentType:** (optional) This is a string that declares the mime-type of the file. It is useful if the transport mechanism is different than the file being delivered, as is the case with a torrents. +- `uri` **(required)**: This is the uri where the media file resides. +- `contentType` (optional): This is a string that declares the mime-type of the file. It is useful if the transport mechanism is different than the file being delivered, as is the case with a torrents. ### Examples diff --git a/docs/tags/trailer.md b/docs/tags/trailer.md index 8d9279b..ad040d1 100644 --- a/docs/tags/trailer.md +++ b/docs/tags/trailer.md @@ -20,11 +20,11 @@ The node value is a string, which is the title of the trailer. It is required. P ### Attributes -- **url:** (required) This is a url that points to the audio or video file to be played. This attribute is a string. -- **pubdate:** (required) The date the trailer was published. This attribute is an RFC2822 formatted date string. -- **length:** (recommended) The length of the file in bytes. This attribute is a number. -- **type:** (recommended) The mime type of the file. This attribute is a string. -- **season:** (optional) If this attribute is present it specifies that this trailer is for a particular season number. This attribute is a number. +- `url` **(required)**: This is a url that points to the audio or video file to be played. This attribute is a string. +- `pubdate` **(required)**: The date the trailer was published. This attribute is an RFC2822 formatted date string. +- `length` (recommended): The length of the file in bytes. This attribute is a number. +- `type` (recommended): The mime type of the file. This attribute is a string. +- `season` (optional): If this attribute is present it specifies that this trailer is for a particular season number. This attribute is a number. If the `season` attribute is present, it must be a number that matches the format of the [``](season.md) tag. So, for a podcast that has 3 published seasons, a new `` tag can be put in the channel to later be matched up with a `4` tag when it is published within a new ``. diff --git a/docs/tags/transcript.md b/docs/tags/transcript.md index 3639965..107c8cd 100644 --- a/docs/tags/transcript.md +++ b/docs/tags/transcript.md @@ -16,10 +16,10 @@ Multiple ### Attributes -- **url (required):** URL of the podcast transcript. -- **type (required):** Mime type of the file such as `text/plain`, `text/html`, `text/vtt`, `application/json`, `application/x-subrip` -- **language (optional):** The language of the linked transcript. If there is no language attribute given, the linked file is assumed to be the same language that is specified by the RSS `` element. -- **rel (optional):** If the rel="captions" attribute is present, the linked file is considered to be a closed captions file, regardless of what the mime type is. In that scenario, time codes are assumed to be present in the file in some capacity. +- `url` **(required)**: URL of the podcast transcript. +- `type` **(required)**: Mime type of the file such as `text/plain`, `text/html`, `text/vtt`, `application/json`, `application/x-subrip` +- `language` (optional): The language of the linked transcript. If there is no language attribute given, the linked file is assumed to be the same language that is specified by the RSS `` element. +- `rel` (optional): If the `rel="captions"` attribute is present, the linked file is considered to be a closed captions file, regardless of what the mime type is. In that scenario, time codes are assumed to be present in the file in some capacity. ### Examples diff --git a/docs/tags/txt.md b/docs/tags/txt.md index e39981e..cccf418 100644 --- a/docs/tags/txt.md +++ b/docs/tags/txt.md @@ -14,7 +14,7 @@ Multiple ### Attributes -- **purpose** (optional) A service specific string that will be used to denote what purpose this tag serves. This could be something like "example.com" if it's a third party hosting platform needing to insert this data, or something like "verify", "release" or any other free form bit of info that is useful to the end consumer that needs it. The free form nature of this tag requires that this attribute is also free formed. This value should not exceed `128 characters`. +- `purpose` (optional): A service specific string that will be used to denote what purpose this tag serves. This could be something like "example.com" if it's a third party hosting platform needing to insert this data, or something like "verify", "release" or any other free form bit of info that is useful to the end consumer that needs it. The free form nature of this tag requires that this attribute is also free formed. This value should not exceed `128 characters`. ### Purposes diff --git a/docs/tags/update-frequency.md b/docs/tags/update-frequency.md index f77c46f..d167ba2 100644 --- a/docs/tags/update-frequency.md +++ b/docs/tags/update-frequency.md @@ -18,9 +18,9 @@ The node value is a free-form string, which might be displayed alongside other i ### Attributes -- **complete (optional):** Boolean specifying if the podcast has no intention to release further episodes. If not set, this should be assumed to be false. -- **dtstart (optional):** The `date` or `datetime` the recurrence rule begins as an [ISO8601-fornmatted](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) string. If the `rrule` contains a value for `COUNT`, then this attribute is required. If the `rrule` contains a value for `UNTIL`, then the value of this attribute must be formatted to the same date/datetime standard. -- **rrule (recommended):** A recurrence rule as defined in [iCalendar RFC 5545 Section 3.3.10](https://www.rfc-editor.org/rfc/rfc5545#section-3.3.10). +- `complete` (optional): Boolean specifying if the podcast has no intention to release further episodes. If not set, this should be assumed to be false. +- `dtstart` (optional): The `date` or `datetime` the recurrence rule begins as an [ISO8601-fornmatted](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) string. If the `rrule` contains a value for `COUNT`, then this attribute is required. If the `rrule` contains a value for `UNTIL`, then the value of this attribute must be formatted to the same date/datetime standard. +- `rrule` (recommended): A recurrence rule as defined in [iCalendar RFC 5545 Section 3.3.10](https://www.rfc-editor.org/rfc/rfc5545#section-3.3.10). ### Examples diff --git a/docs/tags/value-recipient.md b/docs/tags/value-recipient.md index e78ddcd..ce17abe 100644 --- a/docs/tags/value-recipient.md +++ b/docs/tags/value-recipient.md @@ -20,13 +20,13 @@ Multiple ### 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. +- `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. +- `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`. +- `fee` (optional) If this attribute is not specified, it is assumed to be false. ### Examples diff --git a/docs/tags/value-time-split.md b/docs/tags/value-time-split.md index 8b2f3b6..bdc3d27 100644 --- a/docs/tags/value-time-split.md +++ b/docs/tags/value-time-split.md @@ -26,10 +26,10 @@ A single [``](remote-item.md) element OR one or more [``](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. +- `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 [``](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) diff --git a/docs/tags/value.md b/docs/tags/value.md index 34ff65e..93eb5ef 100644 --- a/docs/tags/value.md +++ b/docs/tags/value.md @@ -22,9 +22,9 @@ The node value must be one or more [``](value-recipient. ### 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. +- `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