git.oblomov.eu Git - ikiwiki/blob - doc/ikiwiki/directive/comment.mdwn

   1 The `comment` directive is supplied by the
   2 [[!iki plugins/comments desc=comments]] plugin, and is used to add a comment
   3 to a page. Typically, the directive is the only thing on a comment page,
   4 and is filled out by the comment plugin when a user posts a comment.
   5
   6 Example:
   7
   8         \[[!comment format=mdwn
   9         username="foo"
  10         subject="Bar"
  11         date="2009-06-02T19:05:01Z"
  12         content="""
  13         Blah blah.
  14         """
  15         ]]
  16
  17 ## usage
  18
  19 The only required parameter is `content`, the others just add or override
  20 metadata of the comment.
  21
  22 * `content` - Text to display for the comment.
  23   Note that [[directives|ikiwiki/directive]]
  24   may not be allowed, depending on the configuration
  25   of the comment plugin.
  26 * `format` - Specifies the markup used for the content.
  27 * `subject` - Subject for the comment.
  28 * `date` - Date the comment was posted. Can be entered in
  29   nearly any format, since it's parsed by [[!cpan TimeDate]]
  30 * `username` - Used to record the username (or OpenID)
  31   of a logged in commenter.
  32 * `nickname` - Name to display for a logged in commenter.
  33   (Optional; used for OpenIDs.)
  34 * `ip` - Can be used to record the IP address of a commenter,
  35   if they posted anonymously.
  36 * `claimedauthor` - Records the name that the user entered,
  37   if anonymous commenters are allowed to enter their (unverified)
  38   name.
  39
  40 [[!meta robots="noindex, follow"]]