summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/comment.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'ikiwiki/directive/comment.mdwn')
-rw-r--r--ikiwiki/directive/comment.mdwn42
1 files changed, 42 insertions, 0 deletions
diff --git a/ikiwiki/directive/comment.mdwn b/ikiwiki/directive/comment.mdwn
new file mode 100644
index 0000000..8a9fe62
--- /dev/null
+++ b/ikiwiki/directive/comment.mdwn
@@ -0,0 +1,42 @@
+Die `comment`-Anweisung wird durch die [[!iki plugins/comments
+desc=comments]]-Erweiterung bereitgestellt, und wird zum Hinzufügen von
+Kommentaren zu einer Seite verwendet. Typischerweise ist diese Anweisung das
+Einzige auf einer Kommentarseite, und wird von der comment-Erweiterung
+ausgefüllt, wenn ein Benutzer einen Kommentar veröffentlicht.
+
+Beispiel:
+
+ \[[!comment format=mdwn
+ username="foo"
+ subject="Bar"
+ date="2009-06-02T19:05:01Z"
+ content="""
+ Bla bla.
+ """
+ ]]
+
+## Verwendung
+
+Der einzige erforderliche Parameter ist `content`, die übrigen fügen nur
+Metadaten zu dem Kommentar hinzu oder ändern diese.
+
+* `content` - Text, der in diesem Kommentar angezeigt werden
+ soll. [[Anweisungen|ikiwiki/directive]] sind hier unter Umständen nicht
+ erlaubt, abhängig von der Konfiguration der comment-Erweiterung.
+* `format` - Gibt die Formatierungssprache an, die für den Inhalt verwendet
+ wird.
+* `subject` - Betreff des Kommentars.
+* `date` - Datum, an dem der Kommentar veröffentlicht wurde. Kann in beinahe
+ beliebigem Format angegeben werden, da es von [[!cpan TimeDate]]
+ ausgewertet wird.
+* `username` - Hier wird der Benutzername (oder die OpenID) eines
+ angemeldeten Kommentators gespeichert.
+* `nickname` - Name to display for a logged in commenter. (Optional; used
+ for OpenIDs.)
+* `ip` - Hier kann die IP-Adresse eines Kommentators gespeichert werden,
+ wenn der Kommentar anonym abgegeben wurde.
+* `claimedauthor` - Speichert den Namen, den der Benutzer angegeben hat,
+ wenn anonyme Kommentatoren ihren (nicht verifizierten) Namen angeben
+ dürfen.
+
+[[!meta robots="noindex, follow"]]