]> sipb.mit.edu Git - ikiwiki.git/commitdiff
clarify
authorsmcv <smcv@web>
Thu, 9 Oct 2014 18:36:13 +0000 (14:36 -0400)
committeradmin <admin@branchable.com>
Thu, 9 Oct 2014 18:36:13 +0000 (14:36 -0400)
doc/ikiwiki/directive/comment.mdwn

index 398130e2e820059f7498d71b2ce89d4246649dc4..fdb2c7f8d4cd67f4f00ff53a4d920ca881cd7d01 100644 (file)
@@ -1,7 +1,7 @@
 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.
+[[!iki plugins/comments desc=comments]] plugin, and should be the only
+thing in a comment page. It is usually filled out by
+the comment plugin when a user posts a comment.
 
 Example:
 
@@ -17,7 +17,8 @@ Example:
 ## 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]]