%COMMENT%
without parameters shows a simple text box.
%COMMENT{}%
can handle the following parameters: Parameter | Description | Default |
---|---|---|
type | This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see customization. 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" |
default | Default text to put into the textarea of the prompt. | |
target | Name of the topic to add the comment to | the current topic |
location | Regular expression specifying the comment location in the target topic. Read carefully the CommentPlugin documentation! | |
mode | For compatibility with older versions only, synonymous with type | |
nonotify | Set to "on" to disable change notification for target topics | "off" |
noform | Set to "on" to disable the automatic form that encloses your comment block - remember to insert <form> tags yourself! See CommentPluginExamples#noform for an example. | "off" |
nopost | Set to "on" to disable insertion of the posted text into the topic. | "off" |
remove | Set to "on" to remove the comment prompt after the first time it is clicked. | "off" |
button | Button label text | "Add comment" |
emailto | Send comment by email. Use comma "," to seperate multiple email addresses. This feature is disabled by default. To enable this feature, please set up "$TWiki::cfg{Plugins}{CommentPlugin}{EmailEnabled} = 1;". |
%WORKATTACHTOPIC%
- Expands to a link that lets you attach to the topic (if the user is not able to modify the topic, either in the workflow sense or according to the standard access controls, the link will be %WORKEDITTOPIC%
- Expands to a link that lets you edit the topic (if the user is not able to modify the topic, either in the workflow sense or according to the standard access controls, the link will be %WORKFLOWFORK{...}%
- Expands to a button that will create a copy of the current topic (see below for more details)
%WORKFLOWTRANSITION%
- Expands to either (a) a pull-down menu if the user can perform more than one transition, (b) a button if the current user can only perform one transition, or (c) empty space if the current user is not allowed to perform any action. You can change the format of the button using a CSS class.
%WORKFLOWHISTORY%
- Expands to the history of state transitions the topic has undergone. The format of the history is dictated by the WORKFLOWHISTORYFORMAT
(described below).
%WORKFLOWLASTREV_State%
- Expands to the version number when the document was last in the state State.
%WORKFLOWLASTTIME_State%
- Expands to the timestamp when the document was last in the State last state. For example, %WORKFLOWLASTTIME_APPROVED%
would be replaced by the timestamp when the document was last in the APPROVED
state.
%WORKFLOWLASTVERSION_State%
- Expands to a link to the version of the document when it was last in the state State.
%WORKFLOWSTATE%
- Expands to the current state of the document. It can also be given a topic
parameter (default), in which case the state of that topic is returned.
%WORKFLOWSTATEMESSAGE%
- Expands to the corresponding message in the state table.