doc/todo/comments.mdwn

   1 # Known issues with the [[plugins/comments]] plugin
   2
   3 ## Unimplemented
   4
   5 * Instead of just a link to add a comment, it could have a form to enter
   6   the title, similar to the form for adding a new blog post.
   7
   8   > I'm not sure this is so useful? On Livejournal titles are allowed on
   9   > comments, but very rarely used (and indeed usually not very useful);
  10   > it's hard enough to get some people to title their blog posts :-)
  11   > --[[smcv]]
  12
  13 ## Patches pending merge
  14
  15 * If a spammer posts a comment, it is either impossible or hard to clean
  16   up via the web. Would be nice to have some kind of link on the comment
  17   that allows trusted users to remove it (using the remove plugin of
  18   course).
  19
  20   > Won't the remove plugin refuse to remove internal pages? This would be
  21   > a good feature to have, though. --[[smcv]]
  22
  23   > Here, FWIW, is the first ikiwiki comment spam I've seen:
  24   > <http://waldeneffect.org/blog/Snake_bite_information/#blog/Snake_bite_information/comment_1>
  25   > So that took about 10 days...
  26   > --[[Joey]]
  27
  28   >> Implemented in my 'comments' branch, please review. It turns out
  29   >> [[plugins/remove]] is happy to remove internal pages, so it was quite
  30   >> easy to do. --[[smcv]]
  31
  32 * There is some common code cargo-culted from other plugins (notably inline and editpage) which
  33   should probably be shared
  34
  35   > Actually, there's less of this now than there used to be - a lot of simple
  36   > things that were shared have become unshareable as they became more
  37   > complex. --[[smcv]]
  38
  39   > There's still goto. You have a branch for that. --[[Joey]]
  40
  41 ## Won't fix
  42
  43 * It would be useful to have a pagespec that always matches all comments on
  44   pages matching a glob. Something like `comment(blog/*)`.
  45   Perhaps postcomment could also be folded into this? Then the pagespec
  46   would match both existing comments, as well as new comments that are
  47   being posted.
  48
  49   > Please see [[plugins/comments/discussion]]. If I've convinced you that
  50   > internal pages are the way forward, then sure, we can do that, because
  51   > people who can comment still won't be able to edit others' comments
  52   > (one of my goals is that commenters can't put words into each other's
  53   > mouths :-) )
  54   >
  55   > On the other hand, if you still want me to switch this plugin to "real"
  56   > pages, or if internal pages might become editable in future, then
  57   > configuring lockedit/anonok so a user X can add comments to blog pages
  58   > would also let X edit/delete comments on blog pages (including those
  59   > written by others) in arbitrary ways, which doesn't seem good. --[[smcv]]
  60
  61   > I had a look at implementing comment() and fell afoul of
  62   > some optimisations that assume only internal() will be used to match
  63   > internal pages. So probably this isn't worth doing. --[[Joey]]
  64
  65 ## Done
  66
  67 * The default template should have a (?) icon next to unauthenticated users (with the IP address
  68   as title) and an OpenID icon next to OpenIDs
  69
  70   > Done in my comments git branch, at least as a mockup (using the (?),
  71   > {x} and {*} smileys for anonymous, OpenID and login respectively).
  72   > --[[smcv]]
  73
  74   >> I've improved this to use independent icons from the wikiicons
  75   >> directory (untested!) --[[smcv]]
  76
  77   >>> The new code produces links like /wikiisons/openid.png, which
  78   >>> fail if ikiwiki is not at the root of the web server. --[[Joey]]
  79
  80   >>>> Sorry, I should have spotted that (the assumption failed on my demo
  81   >>>> site, but the push to that site was when I was on the way out, so I
  82   >>>> didn't have time to investigate). As a note for other ikiwiki hackers,
  83   >>>> I should have used
  84   >>>> `<img src="<TMPL_VAR NAME=BASEURL>wikiicons/openid.png" />`. --[[smcv]]
  85
  86   >>> I got to wondering if the icons are needed. On my comments branch
  87   >>> (not master), I've dropped the icons and info can be seen by hovering
  88   >>> over the author's name. Idea being that you probably don't care how
  89   >>> they authenticated unless something is weird, and in that case you
  90   >>> can hover to check. Does that make sense, should I merge it?
  91   >>> --[[Joey]]
  92
  93   >>>> Yeah, go ahead. I preferred my layout with the author before the
  94   >>>> comment - perhaps that's Livejournal's influence :-) - but I can always
  95   >>>> edit the templates for my own site. As long as the default is something
  96   >>>> reasonable and both layouts are possible, I don't really mind.
  97   >>>> Minimizing the number of "resource" files in the basewiki also seems
  98   >>>> a good goal. --[[smcv]]
  99
 100 * Previews always say "unknown IP address"
 101
 102   > Fixed in my comments branch by commits bc66a00b and 95b3bbbf --[[smcv]]
 103
 104 * The Comments link in the "toolbar" is to `index.html#comments`, not the
 105   desired `./#comments`
 106
 107   > Fixed in my comments branch by commit 0844bd0b; commits 5b1cf21a
 108   > and c42f174e fix another `beautify_urlpath` bug and add a regression test
 109   > --[[smcv]]
 110
 111 * Now that inline has some comments-specific functionality anyway, it would
 112   be good to output `<link rel="comments">` in Atom and the equivalent in RSS.
 113
 114   > Fixed in my comments branch by d0d598e4, 3feebe31, 9e5f504e --[[smcv]]
 115
 116
 117 * Add `COMMENTOPENID`: the authenticated/verified user name, if and only if it was an OpenID
 118
 119   > Done in my comments git branch --[[smcv]]
 120
 121   > Not seeing it there, which branch? --[[Joey]]
 122
 123   >> Bah, git push --all is not the default... 'comments' branch now (I've also rebased it).
 124   >> Sorry, I'm on mobile Internet at the moment... --[[smcv]]
 125
 126   >>> merged by [[Joey]] in commit 0f03af38 --[[smcv]]
 127
 128 * Should the comments be visually set off more from the page above?
 129   Rather than just a horizontal rule, I'm thinking put the comments
 130   in a box like is used for inlined pages.
 131
 132   > I did put them in a box in the CSS... I agree the default template
 133   > could do with visual improvement though. --[[smcv]]
 134
 135   >> I'll consider this solved by [[Joey]]'s changes. --[[smcv]]
 136
 137 * One can use inline to set up a feed of all comments posted to any page.
 138   Using template=comment they are displayed right. Only problem
 139   is there is no indication in that template of what page each comment in the
 140   feed is a comment on. So, if a comment is inlined into a different page,
 141   I think it should show a link back to the page commented on.
 142   (BTW, the rss feed in this situation seems ok; there the link element
 143   points back to the parent page.
 144
 145   > done --[[Joey]]
 146
 147 * One of Joey's commit messages says "Not ideal, it would be nicer to jump to
 148   the actual comment posted, but no anchor is available". In fact there is
 149   an anchor - the `\[[_comment]]` preprocessing wraps the comment in a `<div>`
 150   with id="comment_123" or something. I'll fix this, unless Joey gets there
 151   first. --[[smcv]]
 152
 153   > done --[[Joey]]