<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>comments</title> <meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="stylesheet" href="../style.css" type="text/css" /> <link rel="stylesheet" href="../local.css" type="text/css" /> </head> <body> <div class="page"> <div class="pageheader"> <div class="header"> <span> <span class="parentlinks"> <a href="../index.html">ikiwiki</a>/ <a href="../plugins.html">plugins</a>/ </span> <span class="title"> comments </span> </span> </div> </div> <div id="pagebody"> <div id="content" role="main"> <p><span class="infobox"> Plugin: comments<br /> Author: <span class="createlink">Simon McVittie</span><br /> Included in ikiwiki: yes<br /> Enabled by default: no<br /> Included in <a href="./goodstuff.html">goodstuff</a>: no<br /> Currently enabled: no<br /> </span></p> <p>This plugin adds "blog-style" comments. Unlike the wiki-style freeform Discussion pages, these comments are posted by a simple form, cannot later be edited, and rss/atom feeds are provided of each page's comments.</p> <p>When using this plugin, you should also enable <a href="./htmlscrubber.html">htmlscrubber</a> and either <a href="./htmltidy.html">htmltidy</a> or <a href="./htmlbalance.html">htmlbalance</a>. Directives are filtered out by default, to avoid commenters slowing down the wiki by causing time-consuming processing. As long as the recommended plugins are enabled, comment authorship should hopefully be unforgeable by CGI users.</p> <p>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 <a href="./opendiscussion.html">opendiscussion</a>, <a href="./lockedit.html">lockedit</a> and <a href="./anonok.html">anonok</a> pages for details on locking down a wiki so readers can only post comments.</p> <p>Individual comments are stored as internal-use pages named something like <code>page/comment_1</code>, <code>page/comment_2</code>, etc. These pages internally use a <a href="../ikiwiki/directive/comment.html">comment directive</a>.</p> <p>There are some global options for the setup file:</p> <ul> <li><code>comments_pagespec</code>: <a href="../ikiwiki/pagespec.html">PageSpec</a> 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 <code>blog/posts/* and !*/Discussion</code>.</li> <li><code>comments_closed_pagespec</code>: <a href="../ikiwiki/pagespec.html">PageSpec</a> 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. For example: <code>blog/controversial or blog/flamewar</code></li> <li><code>comments_pagename</code>: if this is e.g. <code>comment_</code> (the default), then comment pages will be named something like <code>page/comment_12</code></li> <li><code>comments_allowdirectives</code>: if true (default false), comments may contain IkiWiki <a href="../ikiwiki/directive.html">directives</a></li> <li><code>comments_commit</code>: if true (default true), comments will be committed to the version control system</li> <li><code>comments_allowauthor</code>: if true (default false), anonymous commenters may specify a name for themselves, and the [[!meta author]] and [[!meta authorurl]] directives will not be overridden by the comments plugin</li> </ul> <h2>comment moderation</h2> <p>If you enable the <a href="./blogspam.html">blogspam</a> plugin, comments that appear spammy will be held for moderation. (Or with the <a href="./moderatedcomments.html">moderatedcomments</a> plugin, all comments will be held.) Wiki admins can access the comment moderation queue via a button on their Preferences page.</p> <p>Comments pending moderation are not checked into revision control. To find unmoderated comments, <code>find /your/ikiwiki/srcdir -name '*._comment_pending'</code> To manually moderate a comment, just rename the file, removing the "_pending" from the end, and check it into revision control.</p> </div> </div> <div id="footer" class="pagefooter" role="contentinfo"> <div id="pageinfo"> <div class="tags"> Tags: <a href="./type/comments.html" rel="tag">type/comments</a> <a href="./type/web.html" rel="tag">type/web</a> </div> <div id="backlinks"> Links: <a href="./anonok.html">anonok</a> <a href="./blogspam.html">blogspam</a> <a href="./contrib/album.html">contrib/album</a> <a href="../examples/blog.html">examples/blog</a> <a href="../features.html">features</a> <a href="./goto.html">goto</a> <a href="./lockedit.html">lockedit</a> <a href="./moderatedcomments.html">moderatedcomments</a> <a href="../news/ikiwiki_version_3.0.html">news/ikiwiki version 3.0</a> <a href="../rcs.html">rcs</a> <span class="popup">... <span class="balloon"> <a href="../roadmap.html">roadmap</a> <a href="../tips/comments_feed.html">tips/comments feed</a> <a href="./transient.html">transient</a> <a href="./type/comments.html">type/comments</a> </span> </span> </div> <div class="pagedate"> Last edited <span class="date">Tue Feb 26 23:01:54 2019</span> <!-- Created <span class="date">Tue Feb 26 23:01:54 2019</span> --> </div> </div> <!-- from ikiwiki --> </div> </div> </body> </html>
