aboutsummaryrefslogtreecommitdiff
path: root/doc/ikiwiki/directive/comment.mdwn
blob: 398130e2e820059f7498d71b2ce89d4246649dc4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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.

Example:

	\[[!comment format=mdwn
	username="foo"
	subject="Bar"
	date="2009-06-02T19:05:01Z"
	content="""
	Blah blah.
	"""
	]]

## usage

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"]]