]> sipb.mit.edu Git - ikiwiki.git/blob - doc/todo/feed_enhancements_for_inline_pages.mdwn
inline stuff: reply, new branch pushed to my repo
[ikiwiki.git] / 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 * 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
6
7   > Ok, but blogform.tmpl has the same problem. And either change can need
8   > CSS changes. (blogform in particular is used in style.css as an id.)
9   > So this needs more documentation and associated work. --[[Joey]]
10
11   >> I didn't include blogform in the change because the case of two
12   >> blog post forms in the same page is probably extremely rare. But
13   >> then again I remember doing having them in one of my ikiwiki
14   >> draftings, so I rewrote the patch to include blogform. I had
15   >> checked the distributed CSS for #feedlinks references, without
16   >> finding any. The new patch does include CSS changes for the
17   >> #blogform -> .blogform change. I have no idea on where to document
18   >> this change though.
19
20 * the second patch tries to define the default description for a feed based not only on the wiki name, but also on the current page name. The actual way this is built might not be the optimal one, so I'm open to suggestions
21
22   > I don't really like using "wikiname/page" as the name of the feed. It's
23   > a bit too mechanical. I'd be ok with using just the page name,
24   > with a fallback to wikiname for the toplevel index. Or maybe
25   > something like "$wikiname's $page".
26   > 
27   > Also, shouldn't `pagetitle` be run on the page name? (Haven't checked.)
28   > --[[Joey]] 
29
30   >> The rewritten patch now uses the page title, obtained from meta if
31   >> possible. I introduce a new configuration key to customize
32   >> the actual automatic description allowing combinations of the wiki
33   >> name and page title.
34
35 * the 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
36
37   > Seems reasonable. Cherry-picked. Note that the title attribute
38   > will be shown by browsers as a tooltip. So I made it say 
39   > "$name (RSS feed)"
40
41   >> Good, thanks.
42
43 * the 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
44
45   > Hmm. This doesn't affect the feed links in the blogform.tmpl. Anyway,
46   > this is not something I see a real benefit of making configurable above
47   > the template editing level. I don't see any point whatsoever of
48   > allowing to turn off the feed links in the `<head>` -- they are not
49   > user-visible, and IIRC that is the recommended and most portable way
50   > to encode the information for feed discovery agents (rather than
51   > putting it in the body). And the sorry state of "modern" browsers, 
52   > such as chromium's support for RSS means that it still makes sense to 
53   > have user-visible feed buttons. If that changed, it would make sense to
54   > modify ikiwiki to globally remove them. --[[Joey]]
55
56   >> I was actually quite surprised myself by the lack of automatic feed
57   >> discovery in chromium (although I noticed there's a sort-of
58   >> official plugin to do it). Overall, I believe your critique is
59   >> well-founded, I'll scratch this patch.
60
61 Instead, a new patch has been added, that fixes the url in the feeds to
62 point to included page rather than the including one. This is actually
63 a forgotten piece from the patch that based the feed paths on the
64 included rather than the including page.