Die comment
-Anweisung wird durch die comments-Erweiterung bereitgestellt. In jeder Quelldatei mit Endung
._comment
oder ._comment_pending
sollte eine solche Anweisung vorkommen,
und die Anweisung sollte nirgendwo sonst vorkommen. Kommentare werden
üblicherweise über das Web erzeugt, in diesem Fall erzeugt ikiwiki
automatisch eine passende ._comment
-Datei.
Wiki-Administratoren können Kommentar-Dateien auch direkt zum
Versionskontrollsystem hinzufügen: Ihr Dateiname sollte mit der
Konfigurations-Option comments_pagename beginnen (üblicherweise
comment_
) und mit ._comment
enden, also zum Beispiel
comment_42._comment
.
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. Viele Parameter sind
Abkürzungen für Meta-Anweisungen.
content
- Text, der in diesem Kommentar angezeigt werden soll. Anweisungen 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 TimeDate ausgewertet wird.username
- Hier wird der Benutzername (oder die OpenID) eines angemeldeten Kommentators gespeichert.nickname
- Name der für einen angemeldeten Kommentator angezeigt wird. (Optional, wird für OpenIDs verwendet.)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.