Request review from anyone willing and able.

[ikiwiki.git] / doc / todo / fancypodcast.mdwn

diff --git a/doc/todo/fancypodcast.mdwn b/doc/todo/fancypodcast.mdwn
index 619f5e8149826a2458978c19324af125c0e5bd5c..ea3bebd94dd9f6245fe19c703f1c60887af9f229 100644 (file)
--- a/doc/todo/fancypodcast.mdwn
+++ b/doc/todo/fancypodcast.mdwn
@@ -5,6 +5,38 @@ also have lots more metadata.
 
 [[!toc]]
 
+## Status
+
+[[!template id=gitbranch branch=schmonz/fancypodcast author="[[schmonz]]"]]
+[[!tag patch]]
+
+In summary, the branch preserves ikiwiki's existing podcast behavior,
+adds more featureful behavior, and has been tested to work well in
+some common podcatchers. I believe it is ready for review and
+possible integration, and I'd like to get feedback to that effect
+(or to the contrary) before making further enhancements. I know
+[[joey]]'s the final arbiter here, but I'd appreciate any qualified,
+critical eyes ([[smcv]]?) raking over my diffs. --[[schmonz]]
+
+## Features
+
+[[!table data="""
+Feature            |iTunes RSS|iTunes Atom|Downcast RSS|Downcast Atom
+Feed image         |{X}       |{X}        |{X}         |{X}
+Feed title         |(./)      |(./)       |(./)        |(./)
+Feed publisher     |{X}       |{X}        |{X}         |{X}
+Feed "category"    |{X}       |{X}        |{X}         |{X}
+Feed date          |(./)      |(./)       |(./)        |(./)
+Feed description   |(./)      |(./)       |(./)        |{X}
+Episode image      |{X}       |{X}        |{X}         |{X}
+Episode title      |(./)      |(./)       |(./)        |(./)
+Episode date       |(./)      |(./)       |(./)        |(./)
+Episode duration   |{X}       |{X}        |{X}         |{X}
+Episode author     |{X}       |{X}        |{X}         |{X}
+Episode description|(./)      |(./)       |(./)        |{X}
+Episode enclosure  |(./)      |(./)       |(./)        |(./)
+"""]]
+
 ## Design
 
 7. For each fancy podcast episode, write a blog post containing
@@ -18,9 +50,6 @@ also have lots more metadata.
 
 ## Implementation
 
-[[!template id=gitbranch branch=schmonz/fancypodcast author="[[schmonz]]"]]
-[[!tag patch]]
-
 ### Completed
 
 * Cover the existing simple podcast behavior with tests.
@@ -43,33 +72,20 @@ also have lots more metadata.
 * Subscribe to a fancy feed in some common podcatchers and verify
   display details against a reference podcast.
 
-### Status
-
-[[!table data="""
-Feature            |iTunes RSS|iTunes Atom|Downcast RSS|Downcast Atom
-Feed image         |{X}       |{X}        |{X}         |{X}
-Feed title         |(./)      |(./)       |(./)        |(./)
-Feed publisher     |{X}       |{X}        |{X}         |{X}
-Feed "category"    |{X}       |{X}        |{X}         |{X}
-Feed date          |(./)      |(./)       |(./)        |(./)
-Feed description   |(./)      |(./)       |(./)        |{X}
-Episode image      |{X}       |{X}        |{X}         |{X}
-Episode title      |(./)      |(./)       |(./)        |(./)
-Episode date       |(./)      |(./)       |(./)        |(./)
-Episode duration   |{X}       |{X}        |{X}         |{X}
-Episode author     |{X}       |{X}        |{X}         |{X}
-Episode description|(./)      |(./)       |(./)        |{X}
-Episode enclosure  |(./)      |(./)       |(./)        |(./)
-"""]]
-
 ### Must-have (for [[schmonz]], anyway)
 
 * 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.
+    * Whether [[tips/howto avoid flooding aggregators]] suffices for...
+        * Converting a simple podcast to a fancy one.
+            7. Set up a non-production copy of one of my podcasts.
+                * Manually test that feeds match production.
+                * Subscribe to the copy in `r2e`, iTunes, Downcast.
+            7. Try migrating the copy from simple to fancy.
+                * Document the steps I take.
+                * Make the feed readers update.
+                * Document what happens for each of them.
+        * Migrating a fancy podcast from elsewhere into ikiwiki.
 * Verify that _all_ the tests pass (not just my new ones).
 
 -----
@@ -98,6 +114,12 @@ Episode enclosure  |(./)      |(./)       |(./)        |(./)
         * [mediainfo](http://mediainfo.sourceforge.net/) is way slower
         * Cache computed durations as pagestate
 
+### Fancy podcast aggregating
+
+* Write tests comparing a fancy podcast (HTML and feeds) against
+  the same podcast aggregated and republished, then make them pass
+  via changes to `aggregatepost.impl` and [[plugins/aggregate]].
+
 ### Other ideas
 
 * Optionally specify the enclosure's: