fdd11f156c29d07dee815462697857403dc108a2
[ikiwiki.git] / 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 * Verify that [[plugins/more]] plays well with fancy podcasts.
42 * Verify that the feeds validate.
43 * Subscribe to a fancy feed in some common podcatchers and verify
44   display details against a reference podcast.
45
46 ### Status
47
48 [[!table data="""
49 Feature            |iTunes RSS|iTunes Atom|Downcast RSS|Downcast Atom
50 Feed image         |{X}       |{X}        |{X}         |{X}
51 Feed title         |(./)      |(./)       |(./)        |(./)
52 Feed publisher     |{X}       |{X}        |{X}         |{X}
53 Feed "category"    |{X}       |{X}        |{X}         |{X}
54 Feed date          |(./)      |(./)       |(./)        |(./)
55 Feed description   |(./)      |(./)       |(./)        |{X}
56 Episode image      |{X}       |{X}        |{X}         |{X}
57 Episode title      |(./)      |(./)       |(./)        |(./)
58 Episode date       |(./)      |(./)       |(./)        |(./)
59 Episode duration   |{X}       |{X}        |{X}         |{X}
60 Episode author     |{X}       |{X}        |{X}         |{X}
61 Episode description|(./)      |(./)       |(./)        |{X}
62 Episode enclosure  |(./)      |(./)       |(./)        |(./)
63 """]]
64
65 ### Must-have (for [[schmonz]], anyway)
66
67 * Think carefully about...
68     * UTF-8.
69     * Whether [[tips/howto avoid flooding aggregators]] suffices for...
70         * Converting a simple podcast to a fancy one.
71             7. Set up a non-production copy of one of my podcasts.
72                 * Manually test that feeds match production.
73                 * Subscribe to the copy in `r2e`, iTunes, Downcast.
74             7. Try migrating the copy from simple to fancy.
75                 * Document the steps I take.
76                 * Make the feed readers update.
77                 * Document what happens for each of them.
78         * Migrating a fancy podcast from elsewhere into ikiwiki.
79 * Verify that _all_ the tests pass (not just my new ones).
80
81 -----
82
83 ## Future improvements
84
85 ### iTunes fancy podcasting
86
87 * [iTunes-specific tags](https://www.apple.com/itunes/podcasts/specs.html)
88   appear to be RSS-only
89     * If they work in Atom, teach `inline` to optionally iTunesify RSS/Atom.
90     * Else, add `itunes` as a third kind of feed (RSS plus more stuff).
91 * Notable tags for feeds:
92     * `itunes:subtitle`
93     * `itunes:author`
94     * `itunes:summary` (same as `description`)
95     * `itunes:owner` (includes `itunes:name` and `itunes:email`)
96     * `itunes:image href=''`
97     * `itunes:publisher`
98     * `itunes:category text=''` (can contain subcategories)
99     * `itunes:keywords`
100 * Notable tags for entries:
101     * `itunes:duration`
102         * [[!cpan Audio::TagLib]] might be fastest, if present and applicable
103         * [ffprobe](http://ffmpeg.org/ffprobe.html) is reasonably fast
104         * [mediainfo](http://mediainfo.sourceforge.net/) is way slower
105         * Cache computed durations as pagestate
106
107 ### Fancy podcast aggregating
108
109 * Write tests comparing a fancy podcast (HTML and feeds) against
110   the same podcast aggregated and republished, then make them pass
111   via changes to `aggregatepost.impl` and [[plugins/aggregate]].
112
113 ### Other ideas
114
115 * Optionally specify the enclosure's:
116     * MIME type, in case `File::MimeInfo` guesses wrong.
117     * Duration, in case `ffprobe` guesses wrong.
118 * Optionally specify enclosures outside the wiki:
119     * Some people don't want to store big unchanging files in the VCS.
120     * Other people like [podcasting found media](http://huffduffer.com/about).
121     * We'd have to download the file just to compute some metadata
122       about it, and then somehow not frequently re-download it.
123 * Configurably generate additional subscription links (such as
124   iTunes) alongside the RSS/Atom ones in [[plugins/inline]].
125 * Support Apple's "enhanced podcasts" (if they're still relevant).