Document my fancypodcast WIP.
authorAmitai Schlair <schmonz-web-ikiwiki@schmonz.com>
Wed, 20 Feb 2013 01:13:10 +0000 (20:13 -0500)
committerAmitai Schlair <schmonz-web-ikiwiki@schmonz.com>
Wed, 20 Feb 2013 01:17:47 +0000 (20:17 -0500)
doc/todo/fancypodcast.mdwn [new file with mode: 0644]
doc/users/schmonz.mdwn

diff --git a/doc/todo/fancypodcast.mdwn b/doc/todo/fancypodcast.mdwn
new file mode 100644 (file)
index 0000000..388df0e
--- /dev/null
@@ -0,0 +1,62 @@
+ikiwiki's simple podcasting, while elegant and minimal, doesn't (as
+mentioned in [[todo/blogging]]) produce full-featured feeds. In
+fancy podcasts, episodes are accompanied by text content. The feeds
+also have lots more metadata.
+
+[[!toc]]
+
+## Design
+
+7. For each fancy podcast episode, write a blog post containing
+   `\[[!meta enclosure="WikiLink/to/media.mp3"]]`. (Don't specify
+   more than one enclosure -- but if you do, last one wins.)
+7. When rendering to HTML (single-page or inlined), append a link
+   to the media file.
+7. When rendering to RSS/Atom, the text is the entry's content and
+   the media file is its enclosure.
+7. Don't break simple podcasts in pursuit of fancy podcasts.
+
+## Implementation
+
+[[!template id=gitbranch branch=schmonz/fancypodcast author="[[schmonz]]"]]
+
+### Completed
+
+* Cover the existing simple podcast behavior with tests.
+* Add an `enclosure` field to [[plugins/meta]] that expands the
+  given [[ikiwiki/WikiLink]] to an absolute URL (feed enclosures
+  pretty much need to be, and the reference feeds I've looked at
+  all do this).
+* Write failing tests for the desired single-page and inlined
+  HTML behavior, then make them pass by adding enclosure stanzas
+  to `{,inline}page.tmpl`.
+
+### Must-have (for [[schmonz]], anyway)
+
+* Write failing tests for the desired RSS/Atom behavior, then make
+  them pass, probably via changes to `{atom,rss}item.tmpl` and
+  [[plugins/inline]].
+* Enrich podcast feed metadata (some of which is iTunes-specific,
+  though I'm not aware of it causing any problems for other
+  podcatchers, and in fact some of them may also use it).
+* Subscribe to a fancy feed in some common podcatchers and compare
+  display details against a reference podcast.
+* Compare feature-for-feature and feed-for-feed with
+  [tru_podcast](http://www.rainskit.com/blog/542/tru_podcast-a-podcasting-plugin-for-textpattern),
+  which is what [[schmonz]] will be migrating from.
+* Think carefully about...
+    * UTF-8.
+    * Other templates with `CONTENT` and whether they want to learn
+      about `ENCLOSURE` (maybe `aggregatepost.tmpl`?).
+    * Whether [[tips/howto avoid flooding aggregators]] suffices for
+      migrating a fancy podcast into ikiwiki.
+* Verify that the feeds validate.
+* Verify that _all_ the tests pass (not just my new ones).
+
+### Nice-to-have
+
+* Let the enclosure's MIME type be specified, in case someone ever
+  needs to disagree with `File::MimeInfo`.
+* Extend [[plugins/inline]] to configurably generate additional
+  subscription links (such as iTunes) alongside the RSS/Atom ones.
+* Verify that [[plugins/more]] plays well with fancy podcasts.
index fc7558b240a3b9228f6a937babe1afca9ec77a58..10ca6e6ebe1cbb1bf16ab25fe44ede99be302f99 100644 (file)
@@ -2,7 +2,7 @@
 for all sorts of things. His attempts at contributing:
 
 [[!map
-pages="!*/Discussion and ((link(users/schmonz) and plugins/*) or rcs/cvs)"
+pages="!*/Discussion and ((link(users/schmonz) and plugins/*) or rcs/cvs or todo/fancypodcast)"
 ]]
 
 He's also written a plugin for [WIND