kopia lustrzana https://github.com/Podcastindex-org/podcast-namespace
Adding updateFrequency
Nathan Gathright
rodzic
45dff5ce82
commit
18658ab683
58
docs/1.0.md
58
docs/1.0.md
|
|
@ -36,6 +36,7 @@ The namespace for this extension is `https://podcastindex.org/namespace/1.0`. Cl
|
||||||
- [Txt](#txt)
|
- [Txt](#txt)
|
||||||
- [Remote Item](#remote-item)
|
- [Remote Item](#remote-item)
|
||||||
- [Podroll](#podroll)
|
- [Podroll](#podroll)
|
||||||
|
- [Update Frequency](#update-frequency)
|
||||||
|
|
||||||
<br><br>
|
<br><br>
|
||||||
|
|
||||||
|
|
@ -1142,4 +1143,59 @@ This element allows for a podcaster to include references to one or more podcast
|
||||||
<podcast:remoteItem feedGuid="396d9ae0-da7e-5557-b894-b606231fa3ea" />
|
<podcast:remoteItem feedGuid="396d9ae0-da7e-5557-b894-b606231fa3ea" />
|
||||||
<podcast:remoteItem feedGuid="917393e3-1b1e-5cef-ace4-edaa54e1f810" />
|
<podcast:remoteItem feedGuid="917393e3-1b1e-5cef-ace4-edaa54e1f810" />
|
||||||
</podcast:podroll>
|
</podcast:podroll>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<br><br><br><br><!-- Tag block -->
|
||||||
|
## Update Frequency
|
||||||
|
`<podcast:updateFrequency>`<br><br>
|
||||||
|
This element allows a podcaster to express their intended release schedule as structured data and text.
|
||||||
|
|
||||||
|
### Parent
|
||||||
|
`<channel>`
|
||||||
|
|
||||||
|
### Count
|
||||||
|
Single
|
||||||
|
|
||||||
|
### Node value
|
||||||
|
The node value is a free-form string, which might be displayed alongside other information about the podcast. Please do not exceed `128 characters` for the node value or it may be truncated by aggregators.
|
||||||
|
|
||||||
|
## 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).
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
Recreating most of Apple Podcasts Connect’s “Update Frequency” values is easily achieved:
|
||||||
|
```xml
|
||||||
|
<podcast:updateFrequency rrule="FREQ=DAILY">Daily</podcast:updateFrequency>
|
||||||
|
<podcast:updateFrequency rrule="FREQ=WEEKLY">Weekly</podcast:updateFrequency>
|
||||||
|
<podcast:updateFrequency rrule="FREQ=WEEKLY;INTERVAL=2">Biweekly</podcast:updateFrequency>
|
||||||
|
<podcast:updateFrequency rrule="FREQ=MONTHLY">Monthly</podcast:updateFrequency>
|
||||||
|
<podcast:updateFrequency rrule="FREQ=MONTHLY;INTERVAL=2">Bimonthly</podcast:updateFrequency>
|
||||||
|
<podcast:updateFrequency rrule="FREQ=MONTHLY">Monthly</podcast:updateFrequency>
|
||||||
|
<podcast:updateFrequency rrule="FREQ=YEARLY">Yearly</podcast:updateFrequency>
|
||||||
|
```
|
||||||
|
|
||||||
|
However, greater precision can be easily communicated:
|
||||||
|
```xml
|
||||||
|
<podcast:updateFrequency rrule="FREQ=DAILY;INTERVAL=1;BYDAY=MO,TU,WE,TH,FR">Every weekday</podcast:updateFrequency>
|
||||||
|
<podcast:updateFrequency rrule="FREQ=WEEKLY;BYDAY=MO,WE">Every Monday and Wednesday</podcast:updateFrequency>
|
||||||
|
<podcast:updateFrequency rrule="FREQ=WEEKLY;BYDAY=FR;BYMONTHDAY=13">Every friday the 13th</podcast:updateFrequency>
|
||||||
|
<podcast:updateFrequency rrule="FREQ=YEARLY;BYDAY=+4TH;BYMONTH=11">Every year on American Thanksgiving</podcast:updateFrequency>
|
||||||
|
```
|
||||||
|
|
||||||
|
Limited-run podcasts can indicate when they’ll go on hiatus by setting an UNTIL date or a COUNT:
|
||||||
|
```xml
|
||||||
|
<podcast:updateFrequency rrule="FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;COUNT=10" dtstart="2023-08-28T00:00:00.000Z">Every other Monday for 10 episodes starting on Aug 28, 2023</podcast:updateFrequency>
|
||||||
|
<podcast:updateFrequency rrule="FREQ=WEEKLY;UNTIL=2023-12-31T00:00:00.000Z;BYDAY=MO">Every Monday until Dec 31, 2023</podcast:updateFrequency>
|
||||||
|
```
|
||||||
|
|
||||||
|
Podcasts currently on hiatus can indicate their intention to resume production by setting a DTSTART value in the future:
|
||||||
|
```xml
|
||||||
|
<podcast:updateFrequency dtstart="2025-01-01T00:00:00.000Z" rrule="FREQ=WEEKLY">Weekly, starting in 2025</podcast:updateFrequency>
|
||||||
|
```
|
||||||
|
|
||||||
|
Complete podcasts with no intention to release further episodes:
|
||||||
|
```xml
|
||||||
|
<podcast:updateFrequency complete="true">That’s all folks!</podcast:updateFrequency>
|
||||||
|
```
|
||||||
|
|
|
||||||
|
|
@ -27,8 +27,8 @@ The node value is a free-form string, which might be displayed alongside other i
|
||||||
|
|
||||||
## Attributes
|
## 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.
|
* **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. 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.
|
* **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). Podcasters should not be expected to be able to write a valid recurrence rule themselves. There are [several libraries](https://github.com/topics/rrule) to generate valid recurrence rules from form data or natural language text inputs.
|
* **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
|
## Examples
|
||||||
|
|
||||||
|
|
@ -51,13 +51,18 @@ However, greater precision can be easily communicated:
|
||||||
<podcast:updateFrequency rrule="FREQ=YEARLY;BYDAY=+4TH;BYMONTH=11">Every year on American Thanksgiving</podcast:updateFrequency>
|
<podcast:updateFrequency rrule="FREQ=YEARLY;BYDAY=+4TH;BYMONTH=11">Every year on American Thanksgiving</podcast:updateFrequency>
|
||||||
```
|
```
|
||||||
|
|
||||||
Limited-run series can set expectations clearly:
|
Limited-run podcasts can indicate when they’ll go on hiatus by setting an UNTIL date or a COUNT:
|
||||||
```xml
|
```xml
|
||||||
<podcast:updateFrequency rrule="FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;COUNT=10" dtstart="20230828">Every other Monday for 10 episodes starting on Aug 28, 2023</podcast:updateFrequency>
|
<podcast:updateFrequency rrule="FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;COUNT=10" dtstart="2023-08-28T00:00:00.000Z">Every other Monday for 10 episodes starting on Aug 28, 2023</podcast:updateFrequency>
|
||||||
<podcast:updateFrequency rrule="FREQ=WEEKLY;UNTIL=20231231;BYDAY=MO">Every Monday until Dec 31, 2023</podcast:updateFrequency>
|
<podcast:updateFrequency rrule="FREQ=WEEKLY;UNTIL=2023-12-31T00:00:00.000Z;BYDAY=MO">Every Monday until Dec 31, 2023</podcast:updateFrequency>
|
||||||
```
|
```
|
||||||
|
|
||||||
Completed series with no intention to release further episodes:
|
Podcasts currently on hiatus can indicate their intention to resume production by setting a DTSTART value in the future:
|
||||||
```xml
|
```xml
|
||||||
<podcast:updateFrequency completed="true">That’s all folks!</podcast:updateFrequency>
|
<podcast:updateFrequency dtstart="2025-01-01T00:00:00.000Z" rrule="FREQ=WEEKLY">Weekly, starting in 2025</podcast:updateFrequency>
|
||||||
|
```
|
||||||
|
|
||||||
|
Complete podcasts with no intention to release further episodes:
|
||||||
|
```xml
|
||||||
|
<podcast:updateFrequency complete="true">That’s all folks!</podcast:updateFrequency>
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Ładowanie…
Reference in New Issue