]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/todo/fancypodcast.mdwn
Merge remote-tracking branch 'schmonz/fancypodcast'
[git.ikiwiki.info.git] / doc / todo / fancypodcast.mdwn
index 21aadf1f7f9bbb4112ea0734ee35f7abf663b77b..79b21404930c8b26b3b9362aa6615802534763f2 100644 (file)
@@ -12,11 +12,8 @@ also have lots more metadata.
 
 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]]
+some common podcatchers. I believe it is ready for integration.
+--[[schmonz]]
 
 ## Features
 
@@ -73,6 +70,11 @@ Episode enclosure  |(./)      |(./)       |(./)        |(./)
   display details against a reference podcast.
 * Verify smooth transitions for two common use cases (see testing
   details below).
+* Code review: don't add enclosure divs unless we have enclosures.
+* Code review: genericize download link for more use cases.
+* Code review: don't confuse old readers with Atom names in RSS.
+* Code review: instead of hacking back to `$link`, just provide it.
+* Code review: show author in addition to feedname, if different.
 
 ### Must-have (for [[schmonz]], anyway)
 
@@ -249,6 +251,13 @@ normally no reason to do that. Why does it need an url of this form here?
 > way at the time. If you have a better idea, I'm happy to hear it;
 > if not, I'll add an explanatory comment. --[[schmonz]]
 
+>> I would be more comfortable with this if two two different forms of url
+>> you need were both generated by calling urlto. It'd be fine to call
+>> it more than once. --[[Joey]]
+
+>>> Heh, it was even easier than that! (Hooray for tests.) Done.
+>>> --[[schmonz]]
+
        +<TMPL_IF HTML5><section id="inlineenclosure"><TMPL_ELSE><div id="inlineenclosure"></TMPL_IF>
        +<TMPL_IF ENCLOSURE>
 
@@ -286,6 +295,32 @@ could negatively impact eg, Planet style aggregators using ikiwiki. --[[Joey]]
 > really prefer the old behavior (or don't want to take any chances)?
 > --[[schmonz]]
 
+>> A specific example I know of is updo.debian.net, when used with
+>> rss2email. Without the author name there, one cannot see who posted
+>> an item. It's worth noting that planet.debian.org does the same thing
+>> with its rss feed. (That's probably what I copied.) Atom feeds may
+>> not have this problem, don't know. --[[Joey]]
+
+>>> Okay, that's easy to reproduce. It looks like this _might_ be
+>>> a simple matter of getting \[[!aggregate]] to populate author in
+>>> `add_page()`. I'll see what I can figure out. --[[schmonz]]
+
+>>>> Yep, that was mostly it. If the feed entry defines an author,
+>>>> and the author is distinct from the feed name, we now show `NAME:
+>>>> AUTHOR`, else just show `NAME` (same as always). In addition,
+>>>> the W3 feed validator says `<dcterms:creator>` is invalid, so
+>>>> I replaced it with `<dc:creator>`, and all of a sudden `r2e`
+>>>> gives me better `From:` headers. With the latest on my branch,
+>>>> when I generate the same planet as updo and run `r2e` over it,
+>>>> the names I get in `From:` look like so:
+
+*  `"updo: Junio C Hamano"`
+*  `"updo: Greg Kroah-Hartman"`
+*  `"updo: Eric Raymond: esr"` (article author != feed name, so we get both)
+*  `"updo: Jannis Pohlman: Jannis Pohlmann"` (oops! I tweaked the real updo)
+
+>>>> --[[schmonz]]
+
        +++ b/templates/rsspage.tmpl
        +       xmlns:atom="http://www.w3.org/2005/Atom"
        +<atom:link href="<TMPL_VAR FEEDURL>" rel="self" type="application/rss+xml" />
@@ -295,7 +330,7 @@ every crummy rss reader on earth is going to understand this? I'd put it at
 about 0%; I doubt ikiwiki's own rss reader understands such a mashup.
 --[[Joey]]
 
-> The validator I used (<http://validator.w3.org/>, I think) told me to.
+> The validator I used (<http://validator.w3.org/feed/>) told me to.
 > Pretty sure it doesn't make anything work better in the podcatchers
 > I tried. Hadn't considered that it might break some readers.
 > Removed. --[[schmonz]]
@@ -309,3 +344,5 @@ Does this added tag provide any benefits? --[[Joey]]
 > arrived only in RSS 2.0, but that's already the version we're
 > claiming to be, and it's over a decade old. Seems much less risky
 > than the atom namespace bits. --[[schmonz]]
+
+>> Sounds ok then. --[[Joey]]