Status update and up-move.
[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         |          |           |            |
51 Feed title         |(./)      |(./)       |(./)        |(./)
52 Feed publisher     |          |           |            |
53 Feed "category"    |          |           |            |
54 Feed date          |(./)      |(./)       |(./)        |(./)
55 Feed description   |          |           |            |
56 Episode image      |          |           |            |
57 Episode title      |(./)      |(./)       |(./)        |(./)
58 Episode date       |(./)      |(./)       |(./)        |(./)
59 Episode duration   |          |           |            |
60 Episode author     |(./)      |(./)       |(./)        |(./)
61 Episode description|(./)      |(./)       |(./)        |
62 Episode enclosure  |(./)      |(./)       |(./)        |(./)
63 """]]
64
65 ### Must-have (for [[schmonz]], anyway)
66
67 * Think carefully about...
68     * UTF-8.
69     * Other templates with `CONTENT` and whether they want to learn
70       about `ENCLOSURE` (maybe `aggregatepost.tmpl`?).
71     * Whether [[tips/howto avoid flooding aggregators]] suffices for
72       migrating a fancy podcast into ikiwiki.
73 * Verify that _all_ the tests pass (not just my new ones).
74
75 -----
76
77 ## Future improvements
78
79 ### iTunes fancy podcasting
80
81 * [iTunes-specific tags](https://www.apple.com/itunes/podcasts/specs.html)
82   appear to be RSS-only
83     * If they work in Atom, teach `inline` to optionally iTunesify RSS/Atom.
84     * Else, add `itunes` as a third kind of feed (RSS plus more stuff).
85 * Notable tags for feeds:
86     * `itunes:subtitle`
87     * `itunes:author`
88     * `itunes:summary` (same as `description`)
89     * `itunes:owner` (includes `itunes:name` and `itunes:email`)
90     * `itunes:image href=''`
91     * `itunes:publisher`
92     * `itunes:category text=''` (can contain subcategories)
93     * `itunes:keywords`
94 * Notable tags for entries:
95     * `itunes:duration`
96         * [[!cpan Audio::TagLib]] might be fastest, if present and applicable
97         * [ffprobe](http://ffmpeg.org/ffprobe.html) is reasonably fast
98         * [mediainfo](http://mediainfo.sourceforge.net/) is way slower
99         * Cache computed durations as pagestate
100
101 ### Other ideas
102
103 * Optionally specify the enclosure's:
104     * MIME type, in case `File::MimeInfo` guesses wrong.
105     * Duration, in case `ffprobe` guesses wrong.
106 * Optionally specify enclosures outside the wiki:
107     * Some people don't want to store big unchanging files in the VCS.
108     * Other people like [podcasting found media](http://huffduffer.com/about).
109     * We'd have to download the file just to compute some metadata
110       about it, and then somehow not frequently re-download it.
111 * Configurably generate additional subscription links (such as
112   iTunes) alongside the RSS/Atom ones in [[plugins/inline]].
113 * Support Apple's "enhanced podcasts" (if they're still relevant).