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 [[!tag patch]]
  23
  24 ### Completed
  25
  26 * Cover the existing simple podcast behavior with tests.
  27 * Add an `enclosure` field to [[plugins/meta]] that expands the
  28   given [[ikiwiki/WikiLink]] to an absolute URL (feed enclosures
  29   pretty much need to be, and the reference feeds I've looked at
  30   all do this).
  31 * Write failing tests for the desired single-page and inlined
  32   HTML behavior, then make them pass by adding enclosure stanzas
  33   to `{,inline}page.tmpl`.
  34 * Write failing tests for the desired RSS/Atom behavior, then make
  35   them pass via changes to `{atom,rss}item.tmpl` and [[plugins/inline]].
  36 * Match feature-for-feature with
  37   [tru_podcast](http://www.rainskit.com/blog/542/tru_podcast-a-podcasting-plugin-for-textpattern)
  38   (what [[schmonz]] will be migrating from).
  39 * Enrich [feed metadata](http://cyber.law.harvard.edu/rss/rss.html)
  40   by catching up `rsspage.tmpl` to `atompage.tmpl`.
  41 * Subscribe to a fancy feed in some common podcatchers and verify
  42   display details against a reference podcast.
  43 * Verify that the feeds validate.
  44
  45 ### Must-have (for [[schmonz]], anyway)
  46
  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 _all_ the tests pass (not just my new ones).
  54
  55 -----
  56
  57 ## Future improvements
  58
  59 ### iTunes fancy podcasting
  60
  61 * [iTunes-specific tags](https://www.apple.com/itunes/podcasts/specs.html)
  62   appear to be RSS-only
  63     * If they work in Atom, teach `inline` to optionally iTunesify RSS/Atom.
  64     * Else, add `itunes` as a third kind of feed (RSS plus more stuff).
  65 * Notable tags for feeds:
  66     * `itunes:subtitle`
  67     * `itunes:author`
  68     * `itunes:summary` (same as `description`)
  69     * `itunes:owner` (includes `itunes:name` and `itunes:email`)
  70     * `itunes:image href=''`
  71     * `itunes:publisher`
  72     * `itunes:category text=''` (can contain subcategories)
  73     * `itunes:keywords`
  74 * Notable tags for entries:
  75     * `itunes:duration`
  76         * use `Audio::TagLib` if present and applicable
  77         * fall back to `ffprobe`
  78
  79 ### Other ideas
  80
  81 * Let the enclosure's MIME type be specified, in case someone ever
  82   needs to disagree with `File::MimeInfo`.
  83 * Extend [[plugins/inline]] to configurably generate additional
  84   subscription links (such as iTunes) alongside the RSS/Atom ones.
  85 * Verify that [[plugins/more]] plays well with fancy podcasts.
  86 * Allow enclosures that are outside the wiki.
  87 * Support Apple's "enhanced podcasts" (if they're still relevant).
  88
  89 ### Status
  90
  91 [[!table data="""
  92 Feature            |iTunes RSS|iTunes Atom|Downcast RSS|Downcast Atom
  93 Feed image         |          |           |            |
  94 Feed title         |(./)      |(./)       |(./)        |(./)
  95 Feed publisher     |          |           |            |
  96 Feed "category"    |          |           |            |
  97 Feed date          |(./)      |(./)       |(./)        |(./)
  98 Feed description   |          |           |            |
  99 Episode image      |          |           |            |
 100 Episode title      |(./)      |(./)       |(./)        |(./)
 101 Episode date       |(./)      |(./)       |(./)        |(./)
 102 Episode duration   |          |           |            |
 103 Episode author     |(./)      |(./)       |(./)        |(./)
 104 Episode description|(./)      |(./)       |(./)        |
 105 Episode enclosure  |(./)      |(./)       |(./)        |(./)
 106 """]]