Skip to content

Commit

Permalink
Add reader podcast extensions docs
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Goudriaan <[email protected]>
  • Loading branch information
codedmonkey authored and weierophinney committed Feb 10, 2021
1 parent 64a7626 commit 778a47a
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 1 deletion.
24 changes: 24 additions & 0 deletions docs/book/extensions/podcast-index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Podcast Index Extension

The Podcast Index Extension adds support for the [Podcast Index RSS namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md),
an open source project which consolidates new features for podcasts into a
single namespace.

Channel API methods:

Method | Description
------ | -----------
`isLocked()` | Returns whether the feed is open for importing to new platforms.
`getLockOwner()` | Returns the email address for owner verification.
`getFunding()` | Returns funding information. The output is an object with "url" and "value" properties.

Item API methods:

Method | Description
------ | -----------
`getTranscript()` | Returns transcript information for the entry. The output is an object with "url", "type", "language" and "rel" properties/
`getChapters()` | Returns chapter information for the entry. The output is an object with "url" and "type" properties.
`getSoundbites()` | Returns soundbites for the entry. The output is an array of objects with "title", "startTime" and "duration" properties.

See the [Podcast Index website](https://podcastindex.org) for more information
about the project.
2 changes: 1 addition & 1 deletion docs/book/reader.md
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@ Slash | Implements support for the Slash RSS 1.0 module.
WellFormedWeb | Implements support for the Well Formed Web CommentAPI 1.0.
Thread | Implements support for Atom Threading Extensions as described in RFC 4685.
Podcast | Implements support for the Podcast 1.0 DTD from Apple.
PodcastIndex | Implements support for the Podcast Index 1.0 RSS namespace.
[PodcastIndex](extensions/podcast-index.md) | Implements support for the Podcast Index 1.0 RSS namespace.
GooglePlayPodcast | Implements support for the Google Play Podcasts 1.0 DTD from Google.

The core extensions are somewhat special since they are extremely common and
Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ nav:
- Security: security.md
- Writer: writer.md
- Pubsubhubbub: pubsubhubbub.md
- Extensions:
- 'Podcast Index': extensions/podcast-index.md
site_name: laminas-feed
site_description: 'Consume and generate Atom and RSS feeds, and interact with Pubsubhubbub.'
repo_url: 'https://github.com/laminas/laminas-feed'
Expand Down

0 comments on commit 778a47a

Please sign in to comment.