kopia lustrzana https://github.com/Podcastindex-org/podcast-namespace
update readme
Dave Jones
rodzic
f3cbd1c2c6
commit
9f3a53cd31
64
README.md
64
README.md
|
|
@ -29,8 +29,7 @@ The podcast namespace is part of the larger "Podcasting 2.0" project which exist
|
|||
|
||||
**Phase 4** - [Closed] Comment period closed on `12/1/2021` and [3 tags](https://github.com/Podcastindex-org/podcast-namespace#phase-4-closed-on-1212021) were **formalized**.
|
||||
|
||||
**Phase 5** - [Open] Comment period is open as of `3/2/2022`. Tag submissions and comments are welcome at this time. Tags [here](https://github.com/Podcastindex-org/podcast-namespace#phase-5-open-as-of-322022)
|
||||
are under active consideration. New proposals are also [here](https://github.com/Podcastindex-org/podcast-namespace/issues?q=is%3Aissue+is%3Aopen+label%3Aproposal).
|
||||
**Phase 5** - [Closed] Comment period closed on `7/15/2022`. Tags [here](https://github.com/Podcastindex-org/podcast-namespace#phase-5-closed-on-7152022) are under active consideration.
|
||||
|
||||
<br><br>
|
||||
|
||||
|
|
@ -164,65 +163,10 @@ full implementation details.
|
|||
<br>
|
||||
|
||||
|
||||
## <u>Phase 5 (Open as of 3/2/2022)</u>
|
||||
|
||||
The following tags are being actively considered for adoption into the namespace as part of this phase. They are a work in progress and feedback on them is desired.
|
||||
|
||||
|
||||
<br><br><!-- Tag block -->
|
||||
### **\<podcast:socialInteract>** - <small>[Discuss](https://github.com/Podcastindex-org/podcast-namespace/issues/357)</small>
|
||||
<b>
|
||||
|
||||
```xml
|
||||
<podcast:socialInteract
|
||||
uri="[uri of root post/comment(string)]"
|
||||
protocol="[slug of social protocol being used(slug)]"
|
||||
accountId="[account id of posting party(string)]"
|
||||
accountUrl="[url to posting party's platform profile(string)]"
|
||||
priority="[the order of rendering(int)]"
|
||||
/>
|
||||
```
|
||||
|
||||
</b>
|
||||
|
||||
#### Item
|
||||
|
||||
#### (optional | multiple)
|
||||
|
||||
This element allows a podcaster to attach the "root post" of a comment thread to an episode. This "root post" is treated as the canonical location of where the comments and discussion around this
|
||||
episode will take place. This can be thought of as the "official" social media comment space for this episode. If a protocol such as "activitypub" is used, or some other
|
||||
protocol that allows programmatic API access, these comments can be directly pulled into the app, and replies can be posted back to the thread from the app itself.
|
||||
|
||||
If multiple `<podcast:socialInteract>` tags are given for an `<item>`, the `priority` attribute is strongly recommended to give the app an indication as to which comments to
|
||||
display first.
|
||||
|
||||
This tag can also be used as a signal to platforms and apps that the podcaster does not want public comments shown alongside this episode. For this purpose a `protocol` value
|
||||
of "disabled" can be specified, with no other attributes or node value present.
|
||||
|
||||
#### Attributes
|
||||
- **uri** (required) The uri/url of root post comment.
|
||||
- **protocol** (required) The [protocol](socialprotocols.txt) in use for interacting with the comment root post.
|
||||
- **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 or priority in ascending order of importance. A lower number means higher priority.
|
||||
|
||||
|
||||
Example (simple):
|
||||
```xml
|
||||
<podcast:socialInteract uri="https://podcastindex.social/web/@dave/108013847520053258" protocol="activitypub" accountId="@dave" />
|
||||
```
|
||||
|
||||
Example (complex):
|
||||
```xml
|
||||
<podcast:socialInteract priority="1" uri="https://podcastindex.social/web/@dave/108013847520053258" protocol="activitypub" accountId="@dave" accountUrl="https://podcastindex.social/web/@dave" />
|
||||
<podcast:socialInteract priority="2" uri="https://twitter.com/PodcastindexOrg/status/1507120226361647115" protocol="twitter" accountId="@podcastindexorg" accountUrl="https://twitter.com/PodcastindexOrg" />
|
||||
```
|
||||
|
||||
Example (disabled):
|
||||
```xml
|
||||
<podcast:socialInteract protocol="disabled" />
|
||||
```
|
||||
## <u>Phase 5 (Closed as of 7/15/2022)</u>
|
||||
|
||||
The following tags are under review for inclusion in this phase. Changes to them are now frozen. Any modifications will mean the tag needs
|
||||
to be reworked and submitted to Phase 6.
|
||||
|
||||
|
||||
<br><br><!-- Tag block -->
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue