git.oblomov.eu Git - ikiwiki/blob - 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 ## Design
   9
  10 7. For each fancy podcast episode, write a blog post containing
  11    `\[[!meta enclosure="WikiLink/to/media.mp3"]]`. (Don't specify
  12    more than one enclosure -- but if you do, last one wins.)
  13 7. When rendering to HTML (single-page or inlined), append a link
  14    to the media file.
  15 7. When rendering to RSS/Atom, the text is the entry's content and
  16    the media file is its enclosure.
  17 7. Don't break simple podcasts in pursuit of fancy podcasts.
  18
  19 ## Implementation
  20
  21 [[!template id=gitbranch branch=schmonz/fancypodcast author="[[schmonz]]"]]
  22
  23 ### Completed
  24
  25 * Cover the existing simple podcast behavior with tests.
  26 * Add an `enclosure` field to [[plugins/meta]] that expands the
  27   given [[ikiwiki/WikiLink]] to an absolute URL (feed enclosures
  28   pretty much need to be, and the reference feeds I've looked at
  29   all do this).
  30 * Write failing tests for the desired single-page and inlined
  31   HTML behavior, then make them pass by adding enclosure stanzas
  32   to `{,inline}page.tmpl`.
  33 * Write failing tests for the desired RSS/Atom behavior, then make
  34   them pass, probably via changes to `{atom,rss}item.tmpl` and
  35   [[plugins/inline]].
  36
  37 ### Must-have (for [[schmonz]], anyway)
  38
  39 * Enrich podcast feed metadata (some of which is iTunes-specific,
  40   though I'm not aware of it causing any problems for other
  41   podcatchers, and in fact some of them may also use it).
  42 * Subscribe to a fancy feed in some common podcatchers and compare
  43   display details against a reference podcast.
  44 * Compare feature-for-feature and feed-for-feed with
  45   [tru_podcast](http://www.rainskit.com/blog/542/tru_podcast-a-podcasting-plugin-for-textpattern),
  46   which is what [[schmonz]] will be migrating from.
  47 * Think carefully about...
  48     * UTF-8.
  49     * Other templates with `CONTENT` and whether they want to learn
  50       about `ENCLOSURE` (maybe `aggregatepost.tmpl`?).
  51     * Whether [[tips/howto avoid flooding aggregators]] suffices for
  52       migrating a fancy podcast into ikiwiki.
  53 * Verify that the feeds validate.
  54 * Verify that _all_ the tests pass (not just my new ones).
  55
  56 ### Nice-to-have
  57
  58 * Let the enclosure's MIME type be specified, in case someone ever
  59   needs to disagree with `File::MimeInfo`.
  60 * Extend [[plugins/inline]] to configurably generate additional
  61   subscription links (such as iTunes) alongside the RSS/Atom ones.
  62 * Verify that [[plugins/more]] plays well with fancy podcasts.