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