path: root/ikiwiki/directive/comment.mdwn
diff options
Diffstat (limited to 'ikiwiki/directive/comment.mdwn')
1 files changed, 38 insertions, 0 deletions
diff --git a/ikiwiki/directive/comment.mdwn b/ikiwiki/directive/comment.mdwn
new file mode 100644
index 0000000..a9a7c21
--- /dev/null
+++ b/ikiwiki/directive/comment.mdwn
@@ -0,0 +1,38 @@
+The `comment` directive is supplied by the [[!iki plugins/comments
+desc=comments]] 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.
+ \[[!comment format=mdwn
+ username="foo"
+ subject="Bar"
+ date="2009-06-02T19:05:01Z"
+ content="""
+ Blah blah.
+ """
+ ]]
+## brug
+The only required parameter is `content`, the others just add or override
+metadata of the comment.
+* `content` - Text to display for the comment. Note that
+ [[directives|ikiwiki/directive]] may not be allowed, depending on the
+ configuration of the comment plugin.
+* `format` - Specifies the markup used for the content.
+* `subject` - Subject for the comment.
+* `date` - Date the comment was posted. Can be entered in 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, if anonymous
+ commenters are allowed to enter their (unverified) name.
+[[!meta robots="noindex, follow"]]