04099ec424a631fc129d456633ab410e60dd75ca
[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 * 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
12
13   > I don't really like using "wikiname/page" as the name of the feed. It's
14   > a bit too mechanical. I'd be ok with using just the page name,
15   > with a fallback to wikiname for the toplevel index. Or maybe
16   > something like "$wikiname's $page".
17   > 
18   > Also, shouldn't `pagetitle` be run on the page name? (Haven't checked.)
19   > --[[Joey]] 
20
21 * 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
22
23   > Seems reasonable. Cherry-picked. Note that the title attribute
24   > will be shown by browsers as a tooltip. So I made it say 
25   > "$name (RSS feed)"
26
27 * 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
28
29   > Hmm. This doesn't affect the feed links in the blogform.tmpl. Anyway,
30   > this is not something I see a real benefit of making configurable above
31   > the template editing level. I don't see any point whatsoever of
32   > allowing to turn off the feed links in the `<head>` -- they are not
33   > user-visible, and IIRC that is the recommended and most portable way
34   > to encode the information for feed discovery agents (rather than
35   > putting it in the body). And the sorry state of "modern" browsers, 
36   > such as chromium's support for RSS means that it still makes sense to 
37   > have user-visible feed buttons. If that changed, it would make sense to
38   > modify ikiwiki to globally remove them. --[[Joey]]