Progress, links, an idea, improve table formatting.
[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
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 via changes to `{atom,rss}item.tmpl` and [[plugins/inline]].
35 * Match feature-for-feature with
36   [tru_podcast](http://www.rainskit.com/blog/542/tru_podcast-a-podcasting-plugin-for-textpattern)
37   (what [[schmonz]] will be migrating from).
38
39 ### Must-have (for [[schmonz]], anyway)
40
41 * Enrich [podcast feed metadata](http://cyber.law.harvard.edu/rss/rss.html)
42   (some of which is
43   [iTunes-specific](https://www.apple.com/itunes/podcasts/specs.html),
44   though I'm not aware of it causing any problems for other
45   podcatchers, and in fact some of them may also use it).
46 * Subscribe to a fancy feed in some common podcatchers and verify
47   display details against a reference podcast.
48 * Think carefully about...
49     * UTF-8.
50     * Other templates with `CONTENT` and whether they want to learn
51       about `ENCLOSURE` (maybe `aggregatepost.tmpl`?).
52     * Whether [[tips/howto avoid flooding aggregators]] suffices for
53       migrating a fancy podcast into ikiwiki.
54 * Verify that the feeds validate.
55 * Verify that _all_ the tests pass (not just my new ones).
56
57 ### Nice-to-have
58
59 * Let the enclosure's MIME type be specified, in case someone ever
60   needs to disagree with `File::MimeInfo`.
61 * Extend [[plugins/inline]] to configurably generate additional
62   subscription links (such as iTunes) alongside the RSS/Atom ones.
63 * Verify that [[plugins/more]] plays well with fancy podcasts.
64 * Allow enclosures that are outside the wiki.
65 * Support Apple's "enhanced podcasts" (if they're still relevant).
66
67 ### Status
68
69 [[!table data="""
70 Feature            |iTunes RSS|iTunes Atom|Downcast RSS|Downcast Atom
71 Feed image         |          |           |            |
72 Feed title         |(./)      |(./)       |(./)        |(./)
73 Feed publisher     |          |           |            |
74 Feed "category"    |          |           |            |
75 Feed date          |(./)      |(./)       |(./)        |(./)
76 Feed description   |          |           |            |
77 Episode image      |          |           |            |
78 Episode title      |(./)      |(./)       |(./)        |(./)
79 Episode date       |(./)      |(./)       |(./)        |(./)
80 Episode duration   |          |           |            |
81 Episode author     |(./)      |(./)       |(./)        |(./)
82 Episode description|(./)      |(./)       |(./)        |
83 Episode enclosure  |(./)      |(./)       |(./)        |(./)
84 """]]
85
86 Notes:
87
88 * RSS appears to be strongly preferred over Atom for podcasting.