second review pass and I have a revert branch now

[git.ikiwiki.info.git] / doc / plugins / comments.mdwn

diff --git a/doc/plugins/comments.mdwn b/doc/plugins/comments.mdwn
index afaf2c7ae66dfd60985590f4c5ee279f01e0c145..48b6c6ae7a8f7462e3f98d4db0856baa1d93f85d 100644 (file)
--- a/doc/plugins/comments.mdwn
+++ b/doc/plugins/comments.mdwn
@@ -1,5 +1,5 @@
 [[!template id=plugin name=comments author="[[Simon_McVittie|smcv]]"]]
-[[!tag type/useful]]
+[[!tag type/web]]
 
 This plugin adds "blog-style" comments. Unlike the wiki-style freeform 
 Discussion pages, these comments are posted by a simple form, cannot later
@@ -14,18 +14,19 @@ authorship should hopefully be unforgeable by CGI users.
 The intention is that on a non-wiki site (like a blog) you can lock all
 pages for admin-only access, then allow otherwise unprivileged (or perhaps
 even anonymous) users to comment on posts. See the documentation of the
-[[lockedit]] and [[anonok]] pages for details on locking down a wiki so
-users can only post comments.
+[[opendiscussion]], [[lockedit]] and [[anonok]] pages for details on locking
+down a wiki so readers can only post comments.
 
 Individual comments are stored as internal-use pages named something like
 `page/comment_1`, `page/comment_2`, etc. These pages internally use a
-`\[[!_comment]]` [[ikiwiki/directive]].
+[[comment_directive|ikiwiki/directive/comment]].
 
 There are some global options for the setup file:
 
 * `comments_pagespec`: [[ikiwiki/PageSpec]] of pages where comments are
   allowed. The default is not to allow comments on any pages. To allow
-  comments to all posts to a blog, you could use `blog/* and !*/Discussion`.
+  comments to all posts to a blog, you could use
+  `blog/posts/* and !*/Discussion`.
 * `comments_closed_pagespec`: [[ikiwiki/PageSpec]] of pages where
   posting of new comments is closed, but any existing comments will still
   be displayed. Often you will list a set of individual pages here.
@@ -40,3 +41,15 @@ There are some global options for the setup file:
   specify a name for themselves, and the \[[!meta author]] and
   \[[!meta authorurl]] directives will not be overridden by the comments
   plugin
+
+## comment moderation
+
+If you enable the [[blogspam]] plugin, comments that appear spammy will be
+held for moderation. (Or with the [[moderatedcomments]] plugin, all
+comments will be held.) Wiki admins can access the comment moderation queue
+via a button on their Preferences page.
+
+Comments pending moderation are not checked into revision control.
+To find unmoderated comments, `find /your/ikiwiki/srcdir -name '*._comment_pending'`
+To manually moderate a comment, just rename the file, removing the
+"_pending" from the end, and check it into revision control.