(no commit message)

[git.ikiwiki.info.git] / doc / ikiwiki / directive / comment.mdwn

diff --git a/doc/ikiwiki/directive/comment.mdwn b/doc/ikiwiki/directive/comment.mdwn
index f03664d133656cd68d7570505f0c27ca26ec671a..590ad5c6be489e128d93f8e93ebe1a98f2344d92 100644 (file)
--- a/doc/ikiwiki/directive/comment.mdwn
+++ b/doc/ikiwiki/directive/comment.mdwn
@@ -1,7 +1,15 @@
 The `comment` directive is supplied by the
 The `comment` directive is supplied by the

-[[!iki plugins/comment desc=comment]] plugin, and is used to add a comment
-to a page. Typically, the directive is the only thing on a comment page,
-and is 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:
 
 
 Example:
 


@@ -17,7 +25,8 @@ Example:
 ## usage
 
 The only required parameter is `content`, the others just add or override
 ## usage
 
 The only required parameter is `content`, the others just add or override

-metadata of the comment.
+metadata for the comment. Many parameters are shortcuts for [[meta]]
+directives.

 
 * `content` - Text to display for the comment.
   Note that [[directives|ikiwiki/directive]]
 
 * `content` - Text to display for the comment.
   Note that [[directives|ikiwiki/directive]]


@@ -29,10 +38,12 @@ metadata of the comment.
   nearly any format, since it's parsed by [[!cpan TimeDate]]
 * `username` - Used to record the username (or OpenID)
   of a logged in commenter.
   nearly any format, since it's parsed by [[!cpan TimeDate]]
 * `username` - Used to record the username (or OpenID)
   of a logged in commenter.

+* `nickname` - Name to display for a logged in commenter.
+  (Optional; used for OpenIDs.)

 * `ip` - Can be used to record the IP address of a commenter,
   if they posted anonymously.
 * `claimedauthor` - Records the name that the user entered,
 * `ip` - Can be used to record the IP address of a commenter,
   if they posted anonymously.
 * `claimedauthor` - Records the name that the user entered,

-  if anonmous commenters are allowed to enter their (unverified)
+  if anonymous commenters are allowed to enter their (unverified)

   name.
 
 [[!meta robots="noindex, follow"]]
   name.
 
 [[!meta robots="noindex, follow"]]