data/TWiki/VarCOMMENT.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
colas@0
     1
%META:TOPICINFO{author="TWikiContributor" date="1182547552" format="1.1" version="1"}%
colas@0
     2
%META:TOPICPARENT{name="TWikiVariables"}%
colas@0
     3
#VarCOMMENT
colas@0
     4
---+++ COMMENT{ _attributes_ } -- insert an edit box into the topic to easily add comments.
colas@0
     5
%STARTSECTION{"comment_attributes"}%
colas@0
     6
   * A =%<nop>COMMENT%= without parameters shows a simple text box.
colas@0
     7
   * The following standard attributes are recognized
colas@0
     8
     | *Name* | *Description* | *Default* |
colas@0
     9
     | =type= | This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see [[CommentPlugin#TemPlates][Customisation]], below. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences. | =below= |
colas@0
    10
     | =default= | Default text to put into the textarea of the prompt. | |
colas@0
    11
     | =target= | Name of the topic to add the comment to | the current topic |
colas@0
    12
     | =location= | Regular expression specifying the comment location in the target topic. Read _carefully_ the CommentPlugin documentation! | |
colas@0
    13
     | =mode= | For compatibility with older versions only, synonymous with =type= | |
colas@0
    14
     | =nonotify= | Set to "on" to disable change notification for target topics | =off= |
colas@0
    15
     | =noform= | Set to "on" to disable the automatic form that encloses your comment block - _remember_ to insert =&lt;form&gt;= tags yourself! See CommentPluginExamples#noform for an example. | =off= |
colas@0
    16
     | =nopost= | Set to "on" to disable insertion of the posted text into the topic. | =off= |
colas@0
    17
     | =remove= | Set to "on" to remove the comment prompt after the first time it is clicked. | =off= |
colas@0
    18
     | =button= | Button label text | =Add comment= |
colas@0
    19
%ENDSECTION{"comment_attributes"}%
colas@0
    20
   * See CommentPlugin for more information