diff options
| author | smcv <smcv@web> | 2014-10-09 14:36:13 -0400 |
|---|---|---|
| committer | admin <admin@branchable.com> | 2014-10-09 14:36:13 -0400 |
| commit | 45e2832d468c0dd227742569a5bd49fd8cd619a5 (patch) | |
| tree | 5c6333364691e482b5140c195281504c38bade58 | |
| parent | 0d7bf725a880b3d66b579df3aab1dccf797a1e5c (diff) | |
| download | ikiwiki-45e2832d468c0dd227742569a5bd49fd8cd619a5.tar ikiwiki-45e2832d468c0dd227742569a5bd49fd8cd619a5.tar.gz | |
clarify
| -rw-r--r-- | doc/ikiwiki/directive/comment.mdwn | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/ikiwiki/directive/comment.mdwn b/doc/ikiwiki/directive/comment.mdwn index 398130e2e..fdb2c7f8d 100644 --- a/doc/ikiwiki/directive/comment.mdwn +++ b/doc/ikiwiki/directive/comment.mdwn @@ -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]] |