<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>comment</title> <meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="stylesheet" href="../../style.css" type="text/css" /> <link rel="stylesheet" href="../../local.css" type="text/css" /> <meta name="robots" content="noindex, follow" /> </head> <body> <div class="page"> <div class="pageheader"> <div class="header"> <span> <span class="parentlinks"> <a href="../../index.html">ikiwiki</a>/ <a href="../../ikiwiki.html">ikiwiki</a>/ <a href="../directive.html">directive</a>/ </span> <span class="title"> comment </span> </span> </div> </div> <div id="pagebody"> <div id="content" role="main"> <p>The <code>comment</code> directive is supplied by the <a href="http://ikiwiki.info/plugins/comments/">comments</a> plugin. There should be one comment directive in each source file with extension <code>._comment</code> or <code>._comment_pending</code>, and the directive should not appear anywhere else. Comments are normally created via the web, in which case ikiwiki automatically creates a suitable <code>._comment</code> file.</p> <p>Wiki administrators can also commit comment files to the version control system directly: they should be named starting with the <em>comments_pagename</em> config option (usually <code>comment_</code>) and ending with <code>._comment</code>, for instance <code>comment_42._comment</code>.</p> <p>Example:</p> <pre><code>[[!comment format=mdwn username="foo" subject="Bar" date="2009-06-02T19:05:01Z" content=""" Blah blah. """ ]] </code></pre> <h2>usage</h2> <p>The only required parameter is <code>content</code>, the others just add or override metadata for the comment. Many parameters are shortcuts for <a href="./meta.html">meta</a> directives.</p> <ul> <li><code>content</code> - Text to display for the comment. Note that <a href="../directive.html">directives</a> may not be allowed, depending on the configuration of the comment plugin.</li> <li><code>format</code> - Specifies the markup used for the content.</li> <li><code>subject</code> - Subject for the comment.</li> <li><code>date</code> - Date the comment was posted. Can be entered in nearly any format, since it's parsed by <a href="http://search.cpan.org/search?mode=dist&query=TimeDate">TimeDate</a></li> <li><code>username</code> - Used to record the username (or OpenID) of a logged in commenter.</li> <li><code>nickname</code> - Name to display for a logged in commenter. (Optional; used for OpenIDs.)</li> <li><code>ip</code> - Can be used to record the IP address of a commenter, if they posted anonymously.</li> <li><code>claimedauthor</code> - Records the name that the user entered, if anonymous commenters are allowed to enter their (unverified) name.</li> </ul> </div> </div> <div id="footer" class="pagefooter" role="contentinfo"> <div id="pageinfo"> <div id="backlinks"> Links: <a href="../../plugins/comments.html">plugins/comments</a> </div> <div class="pagedate"> Last edited <span class="date">Tue Feb 26 23:01:54 2019</span> <!-- Created <span class="date">Tue Feb 26 23:01:54 2019</span> --> </div> </div> <!-- from ikiwiki --> </div> </div> </body> </html>