doc/bugs/rss_feeds_do_not_use_recommended_encoding_of_entities_for_some_fields.mdwn

   1 The Atom and RSS templates use `ESCAPE=HTML` in the title elements. However, HTML-escaped characters aren't valid according to <http://feedvalidator.org/>.
   2
   3 Removing `ESCAPE=HTML` works fine, but I haven't checked to see if there are any characters it won't work for.
   4
   5 For Atom, at least, I believe adding `type="xhtml"` to the title element will work. I don't think there's an equivalent for RSS.
   6
   7 > Removing the ESCAPE=HTML will not work, feed validator hates that just as
   8 > much. It wants rss feeds to use a specific style of escaping that happens
   9 > to work in some large percentage of all rss consumers. (Most of which are
  10 > broken).
  11 > <http://www.rssboard.org/rss-profile#data-types-characterdata>
  12 > There's also no actual spec about how this should work.
  13 >
  14 > This will be a total beast to fix. The current design is very clean in
  15 > that all (well, nearly all) xml/html escaping is pushed back to the
  16 > templates. This allows plugins to substitute fields in the templates
  17 > without worrying about getting escaping right in the plugins -- and a
  18 > plugin doesn't even know what kind of template is being filled out when
  19 > it changes a field's value, so it can't do different types of escaping
  20 > for different templates.
  21 >
  22 > The only reasonable approach seems to be extending HTML::Template with an
  23 > ESCAPE=RSS and using that. Unfortunately its design does not allow doing
  24 > so without hacking its code in several places. I've contacted its author
  25 > to see if he'd accept such a patch.
  26 >
  27 > (A secondary bug is that using meta title currently results in unnecessry
  28 > escaping of the title value before it reaches the template. This makes
  29 > the escaping issues show up much more than they need to, since lots more
  30 > characters are currently being double-escaped in the rss.)
  31 >
  32 > --[[Joey]]
  33
  34 > Update: Ok, I've fixed this for titles, as a special case, but the
  35 > underlying problem remains for other fields in rss feeds (such as
  36 > author), so I'm leaving this bug report open. --[[Joey]]
  37
  38 >> I'm curious if there has been any progress on better RSS output?
  39 >> I've been prototyping a new blog and getting good RSS out of it
  40 >> seems important as the bulk of my current readers use RSS.
  41 >> I note, in passing that the "more" plugin doesn't quite do what
  42 >> I want either - I'd like to pass a full RSS feed of a post and only
  43 >> have "more" apply to the front page of the blog. Is there a way to do that?
  44 >> -- [[dtaht]]
  45 >>
  46 >>> To be clear, the RSS spec sucks to such an extent that, as far as
  47 >>> I know, there is no sort of title escaping that will work in all
  48 >>> RSS consumers. Titles are currently escaped in the way
  49 >>> that tends to break the fewest according to what I've read.
  50 >>> If you're unlucky enough to
  51 >>> have a "&" or "<" in your **name**, then you may still run into
  52 >>> problems with how that is escaped in rss feeds. --[[Joey]]