From 79df1b4a504135e5af71849d18c0cf13187cb789 Mon Sep 17 00:00:00 2001 From: smcv Date: Thu, 9 Oct 2014 14:50:00 -0400 Subject: clarify further --- doc/ikiwiki/directive/comment.mdwn | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) (limited to 'doc/ikiwiki') 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: -- cgit v1.2.3