[[!toc]]
+## Status
+
+[[!template id=gitbranch branch=schmonz/fancypodcast author="[[schmonz]]"]]
+[[!tag patch]]
+
+In summary, the branch preserves ikiwiki's existing podcast behavior,
+adds more featureful behavior, and has been tested to work well in
+some common podcatchers. I believe it is ready for review and
+possible integration, and I'd like to get feedback to that effect
+(or to the contrary) before making further enhancements. I know
+[[joey]]'s the final arbiter here, but I'd appreciate any qualified,
+critical eyes ([[smcv]]?) raking over my diffs. --[[schmonz]]
+
+## Features
+
+[[!table data="""
+Feature |iTunes RSS|iTunes Atom|Downcast RSS|Downcast Atom
+Feed image |{X} |{X} |{X} |{X}
+Feed title |(./) |(./) |(./) |(./)
+Feed publisher |{X} |{X} |{X} |{X}
+Feed "category" |{X} |{X} |{X} |{X}
+Feed date |(./) |(./) |(./) |(./)
+Feed description |(./) |(./) |(./) |{X}
+Episode image |{X} |{X} |{X} |{X}
+Episode title |(./) |(./) |(./) |(./)
+Episode date |(./) |(./) |(./) |(./)
+Episode duration |{X} |{X} |{X} |{X}
+Episode author |{X} |{X} |{X} |{X}
+Episode description|(./) |(./) |(./) |{X}
+Episode enclosure |(./) |(./) |(./) |(./)
+"""]]
+
## Design
7. For each fancy podcast episode, write a blog post containing
## Implementation
-[[!template id=gitbranch branch=schmonz/fancypodcast author="[[schmonz]]"]]
-
### Completed
* Cover the existing simple podcast behavior with tests.
HTML behavior, then make them pass by adding enclosure stanzas
to `{,inline}page.tmpl`.
* Write failing tests for the desired RSS/Atom behavior, then make
- them pass, probably via changes to `{atom,rss}item.tmpl` and
- [[plugins/inline]].
+ them pass via changes to `{atom,rss}item.tmpl` and [[plugins/inline]].
+* Match feature-for-feature with
+ [tru_podcast](http://www.rainskit.com/blog/542/tru_podcast-a-podcasting-plugin-for-textpattern)
+ (what [[schmonz]] will be migrating from).
+* Enrich [feed metadata](http://cyber.law.harvard.edu/rss/rss.html)
+ by catching up `rsspage.tmpl` to `atompage.tmpl`.
+* Verify that [[plugins/more]] plays well with fancy podcasts.
+* Verify that the feeds validate.
+* Subscribe to a fancy feed in some common podcatchers and verify
+ display details against a reference podcast.
### Must-have (for [[schmonz]], anyway)
-* Enrich podcast feed metadata (some of which is iTunes-specific,
- though I'm not aware of it causing any problems for other
- podcatchers, and in fact some of them may also use it).
-* Subscribe to a fancy feed in some common podcatchers and compare
- display details against a reference podcast.
-* Compare feature-for-feature and feed-for-feed with
- [tru_podcast](http://www.rainskit.com/blog/542/tru_podcast-a-podcasting-plugin-for-textpattern),
- which is what [[schmonz]] will be migrating from.
* Think carefully about...
* UTF-8.
- * Other templates with `CONTENT` and whether they want to learn
- about `ENCLOSURE` (maybe `aggregatepost.tmpl`?).
- * Whether [[tips/howto avoid flooding aggregators]] suffices for
- migrating a fancy podcast into ikiwiki.
-* Verify that the feeds validate.
+ * Whether [[tips/howto avoid flooding aggregators]] suffices for...
+ * Converting a simple podcast to a fancy one.
+ 7. Set up a non-production copy of one of my podcasts.
+ * Manually test that feeds match production.
+ * Subscribe to the copy in `r2e`, iTunes, Downcast.
+ 7. Try migrating the copy from simple to fancy.
+ * Document the steps I take.
+ * Make the feed readers update.
+ * Document what happens for each of them.
+ * Migrating a fancy podcast from elsewhere into ikiwiki.
* Verify that _all_ the tests pass (not just my new ones).
-### Nice-to-have
+-----
-* Let the enclosure's MIME type be specified, in case someone ever
- needs to disagree with `File::MimeInfo`.
-* Extend [[plugins/inline]] to configurably generate additional
- subscription links (such as iTunes) alongside the RSS/Atom ones.
-* Verify that [[plugins/more]] plays well with fancy podcasts.
+## Future improvements
+
+### iTunes fancy podcasting
+
+* [iTunes-specific tags](https://www.apple.com/itunes/podcasts/specs.html)
+ appear to be RSS-only
+ * If they work in Atom, teach `inline` to optionally iTunesify RSS/Atom.
+ * Else, add `itunes` as a third kind of feed (RSS plus more stuff).
+* Notable tags for feeds:
+ * `itunes:subtitle`
+ * `itunes:author`
+ * `itunes:summary` (same as `description`)
+ * `itunes:owner` (includes `itunes:name` and `itunes:email`)
+ * `itunes:image href=''`
+ * `itunes:publisher`
+ * `itunes:category text=''` (can contain subcategories)
+ * `itunes:keywords`
+* Notable tags for entries:
+ * `itunes:duration`
+ * [[!cpan Audio::TagLib]] might be fastest, if present and applicable
+ * [ffprobe](http://ffmpeg.org/ffprobe.html) is reasonably fast
+ * [mediainfo](http://mediainfo.sourceforge.net/) is way slower
+ * Cache computed durations as pagestate
+
+### Fancy podcast aggregating
+
+* Write tests comparing a fancy podcast (HTML and feeds) against
+ the same podcast aggregated and republished, then make them pass
+ via changes to `aggregatepost.impl` and [[plugins/aggregate]].
+
+### Other ideas
+
+* Optionally specify the enclosure's:
+ * MIME type, in case `File::MimeInfo` guesses wrong.
+ * Duration, in case `ffprobe` guesses wrong.
+* Optionally specify enclosures outside the wiki:
+ * Some people don't want to store big unchanging files in the VCS.
+ * Other people like [podcasting found media](http://huffduffer.com/about).
+ * We'd have to download the file just to compute some metadata
+ about it, and then somehow not frequently re-download it.
+* Configurably generate additional subscription links (such as
+ iTunes) alongside the RSS/Atom ones in [[plugins/inline]].
+* Support Apple's "enhanced podcasts" (if they're still relevant).
sipb-www / ikiwiki.git / blobdiff