doc/todo/fancypodcast.mdwn

   1 ikiwiki's simple podcasting, while elegant and minimal, doesn't (as
   2 mentioned in [[todo/blogging]]) produce full-featured feeds. In
   3 fancy podcasts, episodes are accompanied by text content. The feeds
   4 also have lots more metadata.
   5
   6 [[!toc]]
   7
   8 ## Status
   9
  10 [[!template id=gitbranch branch=schmonz/fancypodcast author="[[schmonz]]"]]
  11 [[!tag patch]]
  12
  13 In summary, the branch preserves ikiwiki's existing podcast behavior,
  14 adds more featureful behavior, and has been tested to work well in
  15 some common podcatchers. I believe it is ready for review and
  16 possible integration, and I'd like to get feedback to that effect
  17 (or to the contrary) before making further enhancements. I know
  18 [[joey]]'s the final arbiter here, but I'd appreciate any qualified,
  19 critical eyes ([[smcv]]?) raking over my diffs. --[[schmonz]]
  20
  21 ## Features
  22
  23 [[!table data="""
  24 Feature            |iTunes RSS|iTunes Atom|Downcast RSS|Downcast Atom
  25 Feed image         |{X}       |{X}        |{X}         |{X}
  26 Feed title         |(./)      |(./)       |(./)        |(./)
  27 Feed publisher     |{X}       |{X}        |{X}         |{X}
  28 Feed "category"    |{X}       |{X}        |{X}         |{X}
  29 Feed date          |(./)      |(./)       |(./)        |(./)
  30 Feed description   |(./)      |(./)       |(./)        |{X}
  31 Episode image      |{X}       |{X}        |{X}         |{X}
  32 Episode title      |(./)      |(./)       |(./)        |(./)
  33 Episode date       |(./)      |(./)       |(./)        |(./)
  34 Episode duration   |{X}       |{X}        |{X}         |{X}
  35 Episode author     |{X}       |{X}        |{X}         |{X}
  36 Episode description|(./)      |(./)       |(./)        |{X}
  37 Episode enclosure  |(./)      |(./)       |(./)        |(./)
  38 """]]
  39
  40 ## Design
  41
  42 7. For each fancy podcast episode, write a blog post containing
  43    `\[[!meta enclosure="WikiLink/to/media.mp3"]]`. (Don't specify
  44    more than one enclosure -- but if you do, last one wins.)
  45 7. When rendering to HTML (single-page or inlined), append a link
  46    to the media file.
  47 7. When rendering to RSS/Atom, the text is the entry's content and
  48    the media file is its enclosure.
  49 7. Don't break simple podcasts in pursuit of fancy podcasts.
  50
  51 ## Implementation
  52
  53 ### Completed
  54
  55 * Cover the existing simple podcast behavior with tests.
  56 * Add an `enclosure` field to [[plugins/meta]] that expands the
  57   given [[ikiwiki/WikiLink]] to an absolute URL (feed enclosures
  58   pretty much need to be, and the reference feeds I've looked at
  59   all do this).
  60 * Write failing tests for the desired single-page and inlined
  61   HTML behavior, then make them pass by adding enclosure stanzas
  62   to `{,inline}page.tmpl`.
  63 * Write failing tests for the desired RSS/Atom behavior, then make
  64   them pass via changes to `{atom,rss}item.tmpl` and [[plugins/inline]].
  65 * Match feature-for-feature with
  66   [tru_podcast](http://www.rainskit.com/blog/542/tru_podcast-a-podcasting-plugin-for-textpattern)
  67   (what [[schmonz]] will be migrating from).
  68 * Enrich [feed metadata](http://cyber.law.harvard.edu/rss/rss.html)
  69   by catching up `rsspage.tmpl` to `atompage.tmpl`.
  70 * Verify that [[plugins/more]] plays well with fancy podcasts.
  71 * Verify that the feeds validate.
  72 * Subscribe to a fancy feed in some common podcatchers and verify
  73   display details against a reference podcast.
  74
  75 ### Must-have (for [[schmonz]], anyway)
  76
  77 * Think carefully about...
  78     * UTF-8.
  79     * Whether [[tips/howto avoid flooding aggregators]] suffices for...
  80         * Converting a simple podcast to a fancy one.
  81             7. Set up a non-production copy of one of my podcasts.
  82                 * Manually test that feeds match production.
  83                 * Subscribe to the copy in `r2e`, iTunes, Downcast.
  84             7. Try migrating the copy from simple to fancy.
  85                 * Document the steps I take.
  86                 * Make the feed readers update.
  87                 * Document what happens for each of them.
  88         * Migrating a fancy podcast from elsewhere into ikiwiki.
  89 * Verify that _all_ the tests pass (not just my new ones).
  90
  91 -----
  92
  93 ## Future improvements
  94
  95 ### iTunes fancy podcasting
  96
  97 * [iTunes-specific tags](https://www.apple.com/itunes/podcasts/specs.html)
  98   appear to be RSS-only
  99     * If they work in Atom, teach `inline` to optionally iTunesify RSS/Atom.
 100     * Else, add `itunes` as a third kind of feed (RSS plus more stuff).
 101 * Notable tags for feeds:
 102     * `itunes:subtitle`
 103     * `itunes:author`
 104     * `itunes:summary` (same as `description`)
 105     * `itunes:owner` (includes `itunes:name` and `itunes:email`)
 106     * `itunes:image href=''`
 107     * `itunes:publisher`
 108     * `itunes:category text=''` (can contain subcategories)
 109     * `itunes:keywords`
 110 * Notable tags for entries:
 111     * `itunes:duration`
 112         * [[!cpan Audio::TagLib]] might be fastest, if present and applicable
 113         * [ffprobe](http://ffmpeg.org/ffprobe.html) is reasonably fast
 114         * [mediainfo](http://mediainfo.sourceforge.net/) is way slower
 115         * Cache computed durations as pagestate
 116
 117 ### Fancy podcast aggregating
 118
 119 * Write tests comparing a fancy podcast (HTML and feeds) against
 120   the same podcast aggregated and republished, then make them pass
 121   via changes to `aggregatepost.impl` and [[plugins/aggregate]].
 122
 123 ### Other ideas
 124
 125 * Optionally specify the enclosure's:
 126     * MIME type, in case `File::MimeInfo` guesses wrong.
 127     * Duration, in case `ffprobe` guesses wrong.
 128 * Optionally specify enclosures outside the wiki:
 129     * Some people don't want to store big unchanging files in the VCS.
 130     * Other people like [podcasting found media](http://huffduffer.com/about).
 131     * We'd have to download the file just to compute some metadata
 132       about it, and then somehow not frequently re-download it.
 133 * Configurably generate additional subscription links (such as
 134   iTunes) alongside the RSS/Atom ones in [[plugins/inline]].
 135 * Support Apple's "enhanced podcasts" (if they're still relevant).