aboutsummaryrefslogtreecommitdiff
path: root/doc/ikiwiki
diff options
context:
space:
mode:
authorsmcv <smcv@web>2014-10-09 14:50:00 -0400
committeradmin <admin@branchable.com>2014-10-09 14:50:00 -0400
commit79df1b4a504135e5af71849d18c0cf13187cb789 (patch)
tree3fffe1c1b15b7617afecf3940bb0064a47d16955 /doc/ikiwiki
parent45e2832d468c0dd227742569a5bd49fd8cd619a5 (diff)
downloadikiwiki-79df1b4a504135e5af71849d18c0cf13187cb789.tar
ikiwiki-79df1b4a504135e5af71849d18c0cf13187cb789.tar.gz
clarify further
Diffstat (limited to 'doc/ikiwiki')
-rw-r--r--doc/ikiwiki/directive/comment.mdwn14
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/ikiwiki/directive/comment.mdwn b/doc/ikiwiki/directive/comment.mdwn
index fdb2c7f8d..590ad5c6b 100644
--- a/doc/ikiwiki/directive/comment.mdwn
+++ b/doc/ikiwiki/directive/comment.mdwn
@@ -1,7 +1,15 @@
The `comment` directive is supplied by the
-[[!iki plugins/comments desc=comments]] plugin, and should be the only
-thing in a comment page. It is usually filled out by
-the comment plugin when a user posts a comment.
+[[!iki plugins/comments desc=comments]] plugin. There should
+be one comment directive in each source file with extension
+`._comment` or `._comment_pending`, and the directive should not
+appear anywhere else. Comments are normally created via the web,
+in which case ikiwiki automatically creates a suitable
+`._comment` file.
+
+Wiki administrators can also commit comment files to the version
+control system directly: they should be named starting with
+the *comments\_pagename* config option (usually `comment_`)
+and ending with `._comment`, for instance `comment_42._comment`.
Example: