tag properly

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

diff --git a/doc/todo/fancypodcast.mdwn b/doc/todo/fancypodcast.mdwn
index fdd11f156c29d07dee815462697857403dc108a2..fe75f58cbbbad0c519f542c7228570f062012d16 100644 (file)
--- a/doc/todo/fancypodcast.mdwn
+++ b/doc/todo/fancypodcast.mdwn
@@ -1,93 +1,53 @@
-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
+## Status

 
 [[!template id=gitbranch branch=schmonz/fancypodcast author="[[schmonz]]"]]
 [[!tag patch]]
 
 
 [[!template id=gitbranch branch=schmonz/fancypodcast author="[[schmonz]]"]]
 [[!tag patch]]
 

-### Completed
+Nothing new since 2013/07/21 [[merge|done]] to `master`.

 
 

-* 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`.
-* Write failing tests for the desired RSS/Atom behavior, then make
-  them pass via changes to `{atom,rss}item.tmpl` and [[plugins/inline]].
-* Match feature-for-feature with
-  [tru_podcast](http://www.rainskit.com/blog/542/tru_podcast-a-podcasting-plugin-for-textpattern)
-  (what [[schmonz]] will be migrating from).
-* Enrich [feed metadata](http://cyber.law.harvard.edu/rss/rss.html)
-  by catching up `rsspage.tmpl` to `atompage.tmpl`.
-* Verify that [[plugins/more]] plays well with fancy podcasts.
-* Verify that the feeds validate.
-* Subscribe to a fancy feed in some common podcatchers and verify
-  display details against a reference podcast.
-
-### Status
+## Features

 
 [[!table data="""
 Feature            |iTunes RSS|iTunes Atom|Downcast RSS|Downcast Atom
 
 [[!table data="""
 Feature            |iTunes RSS|iTunes Atom|Downcast RSS|Downcast Atom

-Feed image         |{X}       |{X}        |{X}         |{X}
+Feed image         |          |           |            |

 Feed title         |(./)      |(./)       |(./)        |(./)
 Feed title         |(./)      |(./)       |(./)        |(./)

-Feed publisher     |{X}       |{X}        |{X}         |{X}
-Feed "category"    |{X}       |{X}        |{X}         |{X}
+Feed publisher     |          |           |            |
+Feed "category"    |          |           |            |

 Feed date          |(./)      |(./)       |(./)        |(./)
 Feed date          |(./)      |(./)       |(./)        |(./)

-Feed description   |(./)      |(./)       |(./)        |{X}
-Episode image      |{X}       |{X}        |{X}         |{X}
+Feed description   |(./)      |(./)       |(./)        |
+Episode image      |          |           |            |

 Episode title      |(./)      |(./)       |(./)        |(./)
 Episode date       |(./)      |(./)       |(./)        |(./)
 Episode title      |(./)      |(./)       |(./)        |(./)
 Episode date       |(./)      |(./)       |(./)        |(./)

-Episode duration   |{X}       |{X}        |{X}         |{X}
-Episode author     |{X}       |{X}        |{X}         |{X}
-Episode description|(./)      |(./)       |(./)        |{X}
+Episode duration   |          |           |            |
+Episode author     |          |           |            |
+Episode description|(./)      |(./)       |(./)        |

 Episode enclosure  |(./)      |(./)       |(./)        |(./)
 """]]
 
 Episode enclosure  |(./)      |(./)       |(./)        |(./)
 """]]
 

-### Must-have (for [[schmonz]], anyway)
-
-* Think carefully about...
-    * UTF-8.
-    * 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).
+## Future improvements

 
 

------
+### Embedded audio/video player in browsers

 
 

-## Future improvements
+* For a given enclosure, depending on autodetected MIME:
+    * `audio/*` -> `<audio>`
+    * `video/*` -> `<video>`
+* For a given template:
+    * `page.tmpl` -> eagerly fetch media
+    * `inlinepage.tmpl` -> fetch just enough to display durations
+* Only for HTML5 sites, or also okay for XHTML?
+* Does this work well enough in enough browsers, or do we need a
+  JavaScript player to fill in some gaps?

 
 ### iTunes fancy podcasting
 
 * [iTunes-specific tags](https://www.apple.com/itunes/podcasts/specs.html)
   appear to be RSS-only
 
 ### iTunes fancy podcasting
 
 * [iTunes-specific tags](https://www.apple.com/itunes/podcasts/specs.html)
   appear to be RSS-only

-    * If they work in Atom, teach `inline` to optionally iTunesify RSS/Atom.
-    * Else, add `itunes` as a third kind of feed (RSS plus more stuff).
+    * Can we always include them in RSS feeds, or would that break
+      some feed readers?
+    * Is it even valid to include them in Atom feeds? If so, do
+      Atom podcasts look any better in podcatchers?
+    * Avoid adding a third kind of feed (`itunesrss`), or options
+      to the existing `rss` and `atom` feeds, unless we have to.

 * Notable tags for feeds:
     * `itunes:subtitle`
     * `itunes:author`
 * Notable tags for feeds:
     * `itunes:subtitle`
     * `itunes:author`


@@ -103,6 +63,9 @@ Episode enclosure  |(./)      |(./)       |(./)        |(./)
         * [ffprobe](http://ffmpeg.org/ffprobe.html) is reasonably fast
         * [mediainfo](http://mediainfo.sourceforge.net/) is way slower
         * Cache computed durations as pagestate
         * [ffprobe](http://ffmpeg.org/ffprobe.html) is reasonably fast
         * [mediainfo](http://mediainfo.sourceforge.net/) is way slower
         * Cache computed durations as pagestate

+* [Podcast Feed Best
+  Practice](https://github.com/gpodder/podcast-feed-best-practice/blob/master/podcast-feed-best-practice.md)
+  from the gPodder folks

 
 ### Fancy podcast aggregating
 
 
 ### Fancy podcast aggregating