doc/plugins/comments.mdwn

   1 [[!template id=plugin name=comments author="[[Simon_McVittie|smcv]]"]]
   2 [[!tag type/web]]
   3
   4 This plugin adds "blog-style" comments. Unlike the wiki-style freeform
   5 Discussion pages, these comments are posted by a simple form, cannot later
   6 be edited, and rss/atom feeds are provided of each page's comments.
   7
   8 When using this plugin, you should also enable [[htmlscrubber]] and either
   9 [[htmltidy]] or [[htmlbalance]]. Directives are filtered out by default, to
  10 avoid commenters slowing down the wiki by causing time-consuming
  11 processing. As long as the recommended plugins are enabled, comment
  12 authorship should hopefully be unforgeable by CGI users.
  13
  14 The intention is that on a non-wiki site (like a blog) you can lock all
  15 pages for admin-only access, then allow otherwise unprivileged (or perhaps
  16 even anonymous) users to comment on posts. See the documentation of the
  17 [[opendiscussion]], [[lockedit]] and [[anonok]] pages for details on locking
  18 down a wiki so readers can only post comments.
  19
  20 Individual comments are stored as internal-use pages named something like
  21 `page/comment_1`, `page/comment_2`, etc. These pages internally use a
  22 [[comment_directive|ikiwiki/directive/comment]].
  23
  24 There are some global options for the setup file:
  25
  26 * `comments_pagespec`: [[ikiwiki/PageSpec]] of pages where comments are
  27   allowed. The default is not to allow comments on any pages. To allow
  28   comments to all posts to a blog, you could use
  29   `blog/posts/* and !*/Discussion`.
  30 * `comments_closed_pagespec`: [[ikiwiki/PageSpec]] of pages where
  31   posting of new comments is closed, but any existing comments will still
  32   be displayed. Often you will list a set of individual pages here.
  33   For example: `blog/controversial or blog/flamewar`
  34 * `comments_pagename`: if this is e.g. `comment_` (the default), then
  35   comment pages will be named something like `page/comment_12`
  36 * `comments_allowdirectives`: if true (default false), comments may
  37   contain IkiWiki [[directives|ikiwiki/directive]]
  38 * `comments_commit`: if true (default true), comments will be committed to
  39   the version control system
  40 * `comments_allowauthor`: if true (default false), anonymous commenters may
  41   specify a name for themselves, and the \[[!meta author]] and
  42   \[[!meta authorurl]] directives will not be overridden by the comments
  43   plugin
  44
  45 ## comment moderation
  46
  47 If you enable the [[blogspam]] plugin, comments that appear spammy will be
  48 held for moderation. (Or with the [[moderatedcomments]] plugin, all
  49 comments will be held.) Wiki admins can access the comment moderation queue
  50 via a button on their Preferences page.
  51
  52 The comments are stored in `.ikiwiki/comments_pending/`, and can be
  53 deleted, or moved into the wiki's srcdir to be posted.