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