path: root/ikiwiki
diff options
authorzweistein <zweistein@web>2020-03-07 13:53:26 +0000
committerIkiWiki <>2020-03-07 13:53:26 +0000
commit3d5b12d22d15291e6cc69a50c4bc8754d0b54817 (patch)
treeac18180388e1d1510d4b8a9a246570ac5962ec0d /ikiwiki
parentc1ce534e101e69a6788371c266c61f2df4a0bb7b (diff)
Diffstat (limited to 'ikiwiki')
1 files changed, 54 insertions, 0 deletions
diff --git a/ikiwiki/directive/comment.mdwn b/ikiwiki/directive/comment.mdwn
new file mode 100644
index 00000000..553c4cab
--- /dev/null
+++ b/ikiwiki/directive/comment.mdwn
@@ -0,0 +1,54 @@
+[[!if test="enabled(comment)"
+ then="In diesem Wiki ist die Direktive: comment **aktiviert**."
+ else="In diesem Wiki ist die Direktive: comment **nicht aktiv**; falls dies gew├╝nscht wird, den Admin benachrichtigen."]]
+The `comment` directive is supplied by the
+[[!iki plugins/comments desc=comments]] plugin. There should
+be one comment directive in each source file with extension
+`._comment` or `._comment_pending`, and the directive should not
+appear anywhere else. Comments are normally created via the web,
+in which case ikiwiki automatically creates a suitable
+`._comment` file.
+Wiki administrators can also commit comment files to the version
+control system directly: they should be named starting with
+the *comments\_pagename* config option (usually `comment_`)
+and ending with `._comment`, for instance `comment_42._comment`.
+ \[[!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 for the comment. Many parameters are shortcuts for [[meta]]
+* `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"]]