Difference: CommentPlugin (15 vs. 16)
Revision 162011-03-28 - TWikiContributor
| Line: 1 to 1 | |||||||||
|---|---|---|---|---|---|---|---|---|---|
Comment Plugin | |||||||||
| Changed: | |||||||||
| < < | |||||||||
| > > | |||||||||
| The Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle. Related topics: CommentPluginTemplates, CommentPluginExamples | |||||||||
| Line: 77 to 77 | |||||||||
| |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| |||||||||
| Changed: | |||||||||
| < < | Your local installation may add more template types as well - see Customisation, below. | ||||||||
| > > | Your local installation may add more template types as well - see Customization, below. | ||||||||
| Changed: | |||||||||
| < < | Customisation | ||||||||
| > > | Customization | ||||||||
| Changed: | |||||||||
| < < | Customisation of the comment plugin requires | ||||||||
| > > | Customization of the comment plugin requires | ||||||||
| |||||||||
| Line: 96 to 96 | |||||||||
The plugin picks up these template definitions from a standard TWiki template file, templates/comments.tmpl. This allows different templates to be defined for different TWiki skins. | |||||||||
| Added: | |||||||||
| > > | |||||||||
Defining custom templatesBy default,templates/comments.tmpl includes the topic CommentPluginTemplate, which contains all the shipped standard templates and in turn includes TWiki.UserCommentsTemplate that can include non-standard customizations. | |||||||||
| Line: 106 to 107 | |||||||||
| |||||||||
| Changed: | |||||||||
| < < | You can also define a comment template in a topic, by passing the topic location with templatetopic. For example:
| ||||||||
| > > |
Per topic custom comment templateYou can also define a comment template in a topic, by passing the topic location with atemplatetopic parameter. For example: | ||||||||
%COMMENT{type="blogpost" templatetopic="BlogPostCommentTemplate" target="%TOPIC%" button="Add comment" }%
| |||||||||
| Changed: | |||||||||
| < < | templatetopic accepts topic or web.topic syntax. See an example in CommentPluginExamples:templatetopic.
| ||||||||
| > > | templatetopic accepts topic or web.topic syntax. See an example in CommentPluginExamples#TemplateTopic. | ||||||||
| Added: | |||||||||
| > > | If you use any topic other than UserCommentTemplate, it is critically important that you include this line at the end of your comment template topic:
%TMPL:INCLUDE{"%SYSTEMWEB%.CommentPlugin"}%
Without this line your templates will not be picked up. | ||||||||
| Changed: | |||||||||
| < < |  Templates are picked up by following the standard TWiki rules for locating template files. Note that you can use %TMPL:INCLUDE to include other files of templates. | ||||||||
| > > | Templates are picked up by following the standard TWiki rules for locating template files. Note that you can use %TMPL:INCLUDE% to include other files of templates. | ||||||||
| Note that from TWiki release 4.1.0 leading and trailing whitespace is no longer stripped. This means that when you upgrade to TWiki 4.1.X you may need to remove the first line break in your custom comment templates. See TWikiReleaseNotes04x01 for more information. | |||||||||
| Changed: | |||||||||
| < < | Customisation example | ||||||||
| > > | Customization example | ||||||||
Provide both a PROMPT and an OUTPUT definition: | |||||||||
| Line: 185 to 192 | |||||||||
| Changed: | |||||||||
| < < | Customisation example with custom form template | ||||||||
| > > | Customization example with custom form template | ||||||||
Write a custom form in a topic.
| |||||||||
| Line: 259 to 266 | |||||||||
Plugin Info | |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| |||||||||
| Changed: | |||||||||
| < < |
| ||||||||
| > > |
| ||||||||
| |||||||||
| Added: | |||||||||
| > > |
| ||||||||
| |||||||||
View topic | History: r22 < r21 < r20 < r19 | More topic actions...
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.CommentPlugin.