TWiki/VarCOMMENT.mdwn

   1 <a name="VarCOMMENT"></a>
   2
   3 ### <a name="COMMENT{ &lt;em&gt;attributes&lt;/em&gt; } -- inser"></a> COMMENT\{ _attributes_ \} -- insert an edit box into the topic to easily add comments.
   4
   5 - A `%COMMENT%` without parameters shows a simple text box.
   6 - The following standard attributes are recognized <table border="1" cellpadding="0" cellspacing="0">
   7   <tr>
   8     <th bgcolor="#99CCCC"><strong> Name </strong></th>
   9     <th bgcolor="#99CCCC"><strong> Description </strong></th>
  10     <th bgcolor="#99CCCC"><strong> Default </strong></th>
  11   </tr>
  12   <tr>
  13     <td><code>type</code></td>
  14     <td> This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see [[Main/CommentPlugin#TemPlates]], below. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your [[Main/WebPreferences]]. </td>
  15     <td><code>below</code></td>
  16   </tr>
  17   <tr>
  18     <td><code>default</code></td>
  19     <td> Default text to put into the textarea of the prompt. </td>
  20     <td>   </td>
  21   </tr>
  22   <tr>
  23     <td><code>target</code></td>
  24     <td> Name of the topic to add the comment to </td>
  25     <td> the current topic </td>
  26   </tr>
  27   <tr>
  28     <td><code>location</code></td>
  29     <td> Regular expression specifying the comment location in the target topic. Read <em>carefully</em> the [[Main/CommentPlugin]] documentation! </td>
  30     <td>   </td>
  31   </tr>
  32   <tr>
  33     <td><code>mode</code></td>
  34     <td> For compatibility with older versions only, synonymous with <code>type</code></td>
  35     <td>   </td>
  36   </tr>
  37   <tr>
  38     <td><code>nonotify</code></td>
  39     <td> Set to "on" to disable change notification for target topics </td>
  40     <td><code>off</code></td>
  41   </tr>
  42   <tr>
  43     <td><code>noform</code></td>
  44     <td> Set to "on" to disable the automatic form that encloses your comment block - <em>remember</em> to insert <code>&lt;form&gt;</code> tags yourself! See [[Main/CommentPluginExamples#noform]] for an example. </td>
  45     <td><code>off</code></td>
  46   </tr>
  47   <tr>
  48     <td><code>nopost</code></td>
  49     <td> Set to "on" to disable insertion of the posted text into the topic. </td>
  50     <td><code>off</code></td>
  51   </tr>
  52   <tr>
  53     <td><code>remove</code></td>
  54     <td> Set to "on" to remove the comment prompt after the first time it is clicked. </td>
  55     <td><code>off</code></td>
  56   </tr>
  57   <tr>
  58     <td><code>button</code></td>
  59     <td> Button label text </td>
  60     <td><code>Add comment</code></td>
  61   </tr>
  62 </table>
  63
  64 - See [[CommentPlugin]] for more information