doc/ikiwiki/directive/comment.mdwn

   1 The `comment` directive is supplied by the
   2 [[!iki plugins/comments desc=comments]] plugin. There should
   3 be one comment directive in each source file with extension
   4 `._comment` or `._comment_pending`, and the directive should not
   5 appear anywhere else. Comments are normally created via the web,
   6 in which case ikiwiki automatically creates a suitable
   7 `._comment` file.
   8
   9 Wiki administrators can also commit comment files to the version
  10 control system directly: they should be named starting with
  11 the *comments\_pagename* config option (usually `comment_`)
  12 and ending with `._comment`, for instance `comment_42._comment`.
  13
  14 Example:
  15
  16         \[[!comment format=mdwn
  17         username="foo"
  18         subject="Bar"
  19         date="2009-06-02T19:05:01Z"
  20         content="""
  21         Blah blah.
  22         """
  23         ]]
  24
  25 ## usage
  26
  27 The only required parameter is `content`, the others just add or override
  28 metadata for the comment. Many parameters are shortcuts for [[meta]]
  29 directives.
  30
  31 * `content` - Text to display for the comment.
  32   Note that [[directives|ikiwiki/directive]]
  33   may not be allowed, depending on the configuration
  34   of the comment plugin.
  35 * `format` - Specifies the markup used for the content.
  36 * `subject` - Subject for the comment.
  37 * `date` - Date the comment was posted. Can be entered in
  38   nearly any format, since it's parsed by [[!cpan TimeDate]]
  39 * `username` - Used to record the username (or OpenID)
  40   of a logged in commenter.
  41 * `nickname` - Name to display for a logged in commenter.
  42   (Optional; used for OpenIDs.)
  43 * `ip` - Can be used to record the IP address of a commenter,
  44   if they posted anonymously.
  45 * `claimedauthor` - Records the name that the user entered,
  46   if anonymous commenters are allowed to enter their (unverified)
  47   name.
  48
  49 [[!meta robots="noindex, follow"]]