doc/todo/feed_enhancements_for_inline_pages.mdwn

   1 [[!template id=gitbranch branch=GiuseppeBilotta/inlinestuff author="Giuseppe Bilotta"]]
   2
   3 A few patches to clean up and improve feed management for inline pages.
   4
   5 (I moved the picked/scratched stuff at the bottom.)
   6
   7 * the second patch tries to define the default description for a feed based not only on the wiki name,
   8   but also on the current page name. The actual way this is built might not be the optimal one,
   9   so I'm open to suggestions
  10
  11   > I don't really like using "wikiname/page" as the name of the feed. It's
  12   > a bit too mechanical. I'd be ok with using just the page name,
  13   > with a fallback to wikiname for the toplevel index. Or maybe
  14   > something like "$wikiname's $page".
  15   >
  16   > Also, shouldn't `pagetitle` be run on the page name? (Haven't checked.)
  17   > --[[Joey]]
  18
  19   >> The rewritten patch now sets the feed title using the page title, and the feed description
  20   >> using the page _description_, both obtained from meta if possible. If there is no page
  21   >> description, then we use the page title combined with the wiki name. I introduce a new
  22   >> configuration key to customize the actual automatic description.
  23
  24   >>> The feed title part of this seems unnecessary. As far as I can see,
  25   >>> ikiwiki already uses the page title as the feed title; TITLE in the
  26   >>> rsspage.tmpl is handled the same as TITLE in page.tmpl. --[[Joey]]
  27
  28   >>>> I'm afraid this is not the case in the ikiwiki I have. It might be the effect of some kind of interaction of
  29   >>>> this with the next patch, but apparently I need both to ensure that the proper title is being used (see also
  30   >>>> below for further details).
  31
  32 * the (new) third patch passes uses the included rather than the including page for the URL. This is
  33   actually a forgotten piece from my previous patch (now upstream) to base the feed name on the
  34   included rather than the including page, and it's only relevant for nested inline pages.
  35
  36   > I have a vague memory of considering doing this before, and not,
  37   > because there is actually no guarantee that the inlined page (that
  38   > itself contains an inline) will generate an url. It could be excluded;
  39   > it could be an internal page; it could use a conditional to omit the
  40   > inline when not inlined.
  41   >
  42   > Also, I think that `destpage` gets set wrong. And I think that
  43   > `get_inline_content` is called with the source page, rather than the
  44   > destpage, and so could generate urls that don't work on the destpage.
  45   >
  46   > All in all, this is an edge case, and currently seems to work ok, so
  47   > why change it? --[[Joey]]
  48
  49   >> Because it does not work ok for me. I have a number of directories `dir1/`, `dir2/`, `dir3/`
  50   >> each with a corresponding `dir1.mdwn`, `dir2.mdwn`, `dir3.mdwn` etc that is basically just
  51   >> an inline instruction. Then my index.mdwn inlines `dir[123]`. Without these two patches, the
  52   >> `dir[123]` feeds get the wrong title.
  53
  54 * the (new) fourth patch introduces a `feedtitle` parameter to override the feed title. I opted for
  55   not squashing it with the second patch to allow you to scrap this but still get the other, in case
  56   you're not too happy about having a plethora of parameters
  57
  58   > This seems clearly a good idea, since there is already a "description"
  59   > parameter. But, by analogy with that parameter, it should just be
  60   > called "title". --[[Joey]]
  61
  62   >> I'll rework the patch to that effect.
  63
  64 * a fifth patch introduces an `id` parameter to allow setting the HTML id attribute in the
  65   blogpost/feedlinks template. Since we replace their id with a class (first patch), this brings
  66   back the possibility for direct CSS customization and JavaScript manipulation based on id.
  67
  68   > That sort of makes sense, but it somehow seems wrong that "id" should
  69   > apply to only cruft at the top of the inline, and not the entire div
  70   > generated for it. --[[Joey]]
  71
  72   >> Good point. I'll look into a way to move the id to the `inlinepage` div, although I guess
  73   >> that falling back to `id`ing the `feedlink` div in the feedonly case would be ok.
  74
  75 * 30a4de2aa3ab29dd9397c2edd91676e80bc06feb "urlto: prevent // when {url} ends with /"
  76
  77   > The `url` in the setup file should not end in a slash. Probably more
  78   > things get ugly doubled slashes if someone does that. --[[Joey]]
  79
  80   >> I was not aware of this. Did I miss it or is it just not documented?
  81
  82 * 57a9b5c4affda9e855f09a64747e5225d6254079 "inline: use urlto instead of manually building the RSS url"
  83
  84   > Well, that seems ok. 3 parameter urlto should give us an absolute url.
  85   >
  86   > But we have to be careful and verify that it will always produce
  87   > exactly the same url as before. Changing the feed url unnecessarily
  88   > can probably flood aggregators or something... --[[Joey]]
  89
  90   >> AFAICS, the feed url would not change (unless the previous patch is also applied and the wiki url ends with a slash)
  91
  92
  93 -----
  94
  95 * the first patch simply replaces the id attribute in the default template for feedlinks with a class attribute by the same name. This is necessary in pages with multiple inlines to guarantee correctness
  96
  97   > Ok, but blogform.tmpl has the same problem. And either change can need
  98   > CSS changes. (blogform in particular is used in style.css as an id.)
  99   > So this needs more documentation and associated work. --[[Joey]]
 100
 101   >> I didn't include blogform in the change because the case of two
 102   >> blog post forms in the same page is probably extremely rare. But
 103   >> then again I remember doing having them in one of my ikiwiki
 104   >> draftings, so I rewrote the patch to include blogform. I had
 105   >> checked the distributed CSS for #feedlinks references, without
 106   >> finding any. The new patch does include CSS changes for the
 107   >> \#blogform -> .blogform change. I have no idea on where to document
 108   >> this change though.
 109
 110   >>> Picked. NEWSed. --[[Joey]]
 111
 112
 113 * the (former) third patch passes the feed titles to the templates, changing the default templates to use these as title attributes for the links. a rel="alternate" attribute is also included
 114
 115   > Seems reasonable. Cherry-picked. Note that the title attribute
 116   > will be shown by browsers as a tooltip. So I made it say
 117   > "$name (RSS feed)"
 118
 119   >> Good, thanks.
 120
 121 * the (former) fourth patch introduces a feedlinks parameter to the inline directive, to allow for the specifications of the locations where the feed links should appear. Currently, two options are allowed (head and body), plus both and none with obvious significance
 122
 123   > Hmm. This doesn't affect the feed links in the blogform.tmpl. Anyway,
 124   > this is not something I see a real benefit of making configurable above
 125   > the template editing level. I don't see any point whatsoever of
 126   > allowing to turn off the feed links in the `<head>` -- they are not
 127   > user-visible, and IIRC that is the recommended and most portable way
 128   > to encode the information for feed discovery agents (rather than
 129   > putting it in the body). And the sorry state of "modern" browsers,
 130   > such as chromium's support for RSS means that it still makes sense to
 131   > have user-visible feed buttons. If that changed, it would make sense to
 132   > modify ikiwiki to globally remove them. --[[Joey]]
 133
 134   >> I was actually quite surprised myself by the lack of automatic feed
 135   >> discovery in chromium (although I noticed there's a sort-of
 136   >> official plugin to do it). Overall, I believe your critique is
 137   >> well-founded, I'll scratch this patch.
 138