X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/65486cd75144b8400870604c6f809d7f6b6fd615..76f925bc8e4f8f4059be13e469e6f63d7bbc3a2f:/doc/todo/feed_enhancements_for_inline_pages.mdwn?ds=inline diff --git a/doc/todo/feed_enhancements_for_inline_pages.mdwn b/doc/todo/feed_enhancements_for_inline_pages.mdwn index 04099ec42..290326d9a 100644 --- a/doc/todo/feed_enhancements_for_inline_pages.mdwn +++ b/doc/todo/feed_enhancements_for_inline_pages.mdwn @@ -8,6 +8,15 @@ A few patches to clean up and improve feed management for inline pages. > CSS changes. (blogform in particular is used in style.css as an id.) > So this needs more documentation and associated work. --[[Joey]] + >> I didn't include blogform in the change because the case of two + >> blog post forms in the same page is probably extremely rare. But + >> then again I remember doing having them in one of my ikiwiki + >> draftings, so I rewrote the patch to include blogform. I had + >> checked the distributed CSS for #feedlinks references, without + >> finding any. The new patch does include CSS changes for the + >> \#blogform -> .blogform change. I have no idea on where to document + >> this change though. + * 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 > I don't really like using "wikiname/page" as the name of the feed. It's @@ -18,13 +27,24 @@ A few patches to clean up and improve feed management for inline pages. > Also, shouldn't `pagetitle` be run on the page name? (Haven't checked.) > --[[Joey]] -* 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 + >> The rewritten patch now sets the feed title using the page title, and the feed description + >> using the page _description_, both obtained from meta if possible. If there is no page + >> description, then we use the page title combined with the wiki name. I introduce a new + >> configuration key to customize the actual automatic description. + +* 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 > Seems reasonable. Cherry-picked. Note that the title attribute > will be shown by browsers as a tooltip. So I made it say > "$name (RSS feed)" -* 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 + >> Good, thanks. + +* the (new) third patch passes uses the included rather than the including page for the URL. This is + actually a forgotten piece from my previous patch (now upstream) to base the feed name on the + included rather than the including page, and it's only relevant for nested inline pages. + +* 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 > Hmm. This doesn't affect the feed links in the blogform.tmpl. Anyway, > this is not something I see a real benefit of making configurable above @@ -36,3 +56,16 @@ A few patches to clean up and improve feed management for inline pages. > such as chromium's support for RSS means that it still makes sense to > have user-visible feed buttons. If that changed, it would make sense to > modify ikiwiki to globally remove them. --[[Joey]] + + >> I was actually quite surprised myself by the lack of automatic feed + >> discovery in chromium (although I noticed there's a sort-of + >> official plugin to do it). Overall, I believe your critique is + >> well-founded, I'll scratch this patch. + +* the (new) fourth patch introduces a `feedtitle` parameter to override the feed title. I opted for + not squashing it with the second patch to allow you to scrap this but sitll get the other, in case + you're not too happy about having a plethora of parameters + +* a fifth patch introduces an `id` parameter to allow setting the HTML id attribute in the + blogpost/feedlinks template. Since we replace their id with a class (first patch), this brings + back the possibility for direct CSS customization and JavaScript manipulation based on id.