]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/commitdiff
clarify further
authorsmcv <smcv@web>
Thu, 9 Oct 2014 18:50:00 +0000 (14:50 -0400)
committeradmin <admin@branchable.com>
Thu, 9 Oct 2014 18:50:00 +0000 (14:50 -0400)
doc/ikiwiki/directive/comment.mdwn

index fdb2c7f8d4cd67f4f00ff53a4d920ca881cd7d01..590ad5c6be489e128d93f8e93ebe1a98f2344d92 100644 (file)
@@ -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: