urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ikiwiki/doc/plugins/comments.mdwn

54 lines
2.7 KiB
Plaintext
Raw Normal View History

first pass through comments documentation Moved documentation out of contrib. Mostly tweaked some wording. Moved documentation of various bits to other pages (pagespec, etc), and linked to those. Documented the new templates in wikitemplates. Small quantities of documentation were removed. Particularly the list of template variables, which I think is fairly obvious when editing the template.
2008-12-12 20:52:05 +01:00
[[!template id=plugin name=comments author="[[Simon_McVittie|smcv]]"]]
plugin tag reorg
2010-02-12 09:38:00 +01:00
[[!tag type/web]]
first pass through comments documentation Moved documentation out of contrib. Mostly tweaked some wording. Moved documentation of various bits to other pages (pagespec, etc), and linked to those. Documented the new templates in wikitemplates. Small quantities of documentation were removed. Particularly the list of template variables, which I think is fairly obvious when editing the template.
2008-12-12 20:52:05 +01:00
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.
When using this plugin, you should also enable [[htmlscrubber]] and either
[[htmltidy]] or [[htmlbalance]]. 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.
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
opendiscussion: This plugin will also now allow posting comments to otherwise locked-down sites.
2010-02-06 22:19:17 +01:00
[[opendiscussion]], [[lockedit]] and [[anonok]] pages for details on locking
down a wiki so readers can only post comments.
first pass through comments documentation Moved documentation out of contrib. Mostly tweaked some wording. Moved documentation of various bits to other pages (pagespec, etc), and linked to those. Documented the new templates in wikitemplates. Small quantities of documentation were removed. Particularly the list of template variables, which I think is fairly obvious when editing the template.
2008-12-12 20:52:05 +01:00
Individual comments are stored as internal-use pages named something like
`page/comment_1`, `page/comment_2`, etc. These pages internally use a
comment: Make comment directives no longer use the internal "_comment" form, and document the comment directive syntax. Rationalle: Comments need to be user-editable so that they can be posted via git commit etc. The _comment directive is still supported, for back-compat.
2009-06-02 23:06:46 +02:00
[[comment_directive|ikiwiki/directive/comment]].
first pass through comments documentation Moved documentation out of contrib. Mostly tweaked some wording. Moved documentation of various bits to other pages (pagespec, etc), and linked to those. Documented the new templates in wikitemplates. Small quantities of documentation were removed. Particularly the list of template variables, which I think is fairly obvious when editing the template.
2008-12-12 20:52:05 +01:00
There are some global options for the setup file:
change around comments pagespecs I think it is clearer to have one pagespec that controls all pages with comments, and a separate pagespec that can be used to close new comments on a subset of those pages.
2008-12-18 00:50:04 +01:00
* `comments_pagespec`: [[ikiwiki/PageSpec]] of pages where comments are
allowed. The default is not to allow comments on any pages. To allow
unify pagespecs
2008-12-21 22:50:50 +01:00
comments to all posts to a blog, you could use
`blog/posts/* and !*/Discussion`.
change around comments pagespecs I think it is clearer to have one pagespec that controls all pages with comments, and a separate pagespec that can be used to close new comments on a subset of those pages.
2008-12-18 00:50:04 +01:00
* `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.
For example: `blog/controversial or blog/flamewar`
first pass through comments documentation Moved documentation out of contrib. Mostly tweaked some wording. Moved documentation of various bits to other pages (pagespec, etc), and linked to those. Documented the new templates in wikitemplates. Small quantities of documentation were removed. Particularly the list of template variables, which I think is fairly obvious when editing the template.
2008-12-12 20:52:05 +01:00
* `comments_pagename`: if this is e.g. `comment_` (the default), then
comment pages will be named something like `page/comment_12`
* `comments_allowdirectives`: if true (default false), comments may
contain IkiWiki [[directives|ikiwiki/directive]]
* `comments_commit`: if true (default true), comments will be committed to
the version control system
* `comments_allowauthor`: 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
comments: If comment content checks fail, store the comment (in .ikiwiki/comments_pending) for moderator review.
2009-01-25 21:42:13 +01:00
## comment moderation
If you enable the [[blogspam]] plugin, comments that appear spammy will be
moderatedcomments: New plugin to allow comment moderation w/o relying on blogspam.net.
2009-10-26 18:24:27 +01:00
held for moderation. (Or with the [[moderatedcomments]] plugin, all
comments will be held.) Wiki admins can access the comment moderation queue
add a button to prefs page for comment moderation
2009-01-26 01:04:45 +01:00
via a button on their Preferences page.
moved comments pending moderation * comments: Comments pending moderation are now stored in the srcdir alongside accepted comments, but with a `._comment_pending` extension. * This allows easier byhand moderation, as the "_pending" need only be stripped off and the comment be committed to version control. * The `comment_pending()` pagespec can be used to match such unmoderated comments, which makes it easy to add a feed of them, or a counter indicating how many there are. * Belatedly added a `comment()` pagespec.
2010-05-07 01:19:51 +02:00
The unmoderated comments are stored in the `srcdir` with a filename ending
in "._comment_pending". They are not checked into revision control.