CustomisationCustomisation of the comment plugin requires
PROMPT:mytype and OUTPUT:mytype respectively. See comments.tmpl in the templates directory for examples.
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.
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 customisations.
This allows for several levels of customisation:
%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.
Customisation exampleProvide both aPROMPT and an OUTPUT definition:
%TMPL:DEF{PROMPT:myComment}%%TMPL:P{promptbox}%%TMPL:END% %TMPL:DEF{OUTPUT:myComment}%%TMPL:P{outputoneliner}%%POS:TOP% %TMPL:END%Call your custom comment with: %COMMENT{type="myComment"}% The
The |
Variable | Description |
---|---|
%DISABLED% | Set to 'disabled' when you cannot comment (e.g. in preview mode). |
%MESSAGE% | The text specified by default . This may be overridden by a helpful message when the prompt is DISABLED. |
save
script is invoked on the target topic, with a number of parameters provided by the comment form. Normally the CommentPlugin will provide these fields in the form, but experts can also provide the fields themselves in order to get finer control over what is submitted, or you might want to define your own HTML forms that do comment submission. The parameters that the CommentPlugin recognises are as follows:
CGI parameter | Description |
---|---|
comment_anchor | Anchor taken from the target spec |
comment_location | As passed to %COMMENT |
comment_nonotify | As passed to %COMMENT |
comment_nopost | As passed to %COMMENT |
comment_action | Must be save to get the CommentPlugin to perform |
comment_type | Type of the OUTPUT template |
comment_remove | Zero-based index of a %COMMENT to remove from the target topic |
comment_index | Zero-based index of the %COMMENT in the source topic. Used to place a post relative to an existing %COMMENT. |
comment_location
overrides comment_anchor
, and both override comment_index
. Example, shows an "I Approve" button that adds your approval signature to the end of the topic:
<form method="post" action="%SCRIPTURL{save}%/%WEB%/%TOPIC%"> <input type="submit" value="I Approve" /> <input type="hidden" name="comment_action" value="save" /> <input type="hidden" name="comment_type" value="bottom" /> <input type="hidden" name="comment" value="I Approve" /> </form>
OUTPUT
template OUTPUT
template defines the format for the text that actually gets embedded into the topic. All the usual TWiki variables are available in the PROMPT
definition, but note that they get expanded when the comment is inserted in the text, so time, date and username will refer to the time and date when the comment was made, and the user who made it.
There are also four position tags that are used to indicate where the comment should be placed, relative to the location
defined in the %COMMENT
tag:
%POS:TOP% | If present, comments will be inserted at the top of the topic i.e. before any other text |
%POS:BOTTOM% | If present, comments will be inserted at the end of the topic i.e. after all existing text |
%POS:BEFORE% | If present, comments will be inserted immediately before the %COMMENT% tag |
%POS:AFTER% | If present, comments will be inserted immediately after the %COMMENT% tag |
DEFAULT_TYPE
All the usual TWikiVariables that can be used in a topic template can also be used in an OUTPUT
template. See TWikiVariables for details.
Preference | Default | Description |
---|---|---|
%COMMENTPLUGIN_TEMPLATES% | comments | Name of template file in the 'templates' directory that contains the comment templates. The default 'comments.tmpl' automatically includes user templates from CommentPluginTemplate, which in turn includes UserCommentsTemplate? . |
%COMMENTPLUGIN_DEFAULT_TYPE% | above | Default template type |
CommentPlugin_installer
to automatically check and install other modules that this module depends on, and enable the plugin.
configure
to enable the plugin
Plugin Author: | TWiki:Main.DavidWeller, TWiki:Main.PeterMasiar, TWiki:Main.CrawfordCurrie http://www.c-dot.co.uk |
Copyright: | © 2004, TWiki:Main.CrawfordCurrie © 2004-2007 TWiki:TWiki.TWikiContributor |
License: | GPL (GNU General Public License) |
Plugin Version: | 12750 (04 Feb 2007) |
Change History: | |
12750 | Item3510 added a note about the changed template spec in TWiki 4.1.0. Code remains unchanged |
11358 | Item2802 moved SHORTDESCRIPTION to .pm. Coded up TWiki:main.PankajPant's suggestions as nopost and remove . Added default text for the %COMMENT as requested by TWiki:Main.AndyGlew |
11118 | Item2322 removed span tag around oneliner bullet output |
8788 | Item1465 Item1577: reverted 8433 to fix inclusion of correct user templates |
8787 | Item1573 renamed standard templates topic to avoid naming clash on Windows, where filenames are case-insensitive |
8433 | Item1465 Fix 'TWiki.' to 'TWiki.'; also fixed include 'UserComments' to 'UserCommentsTemplate' (at least that is what the doc suggests) |
7427 | Item845 removed duplicate date in default comments; stick with server time |
7251 | Item810 fix for user template inclusion; reorganised templates to make customisation easier |
5906 | Item143 apache warning from comment plugin when CommentsTmpl.txt not found |
5519 | CommentPluginOnAnchorsBroken: incorporated JacobEisinger's fix |
5518 | CommentPluginOnAnchorsBroken: incorporated OlivierBerger's fix |
5455 | On Niels Kodslo's prompting, removed the global recursion prevention that I believe is no longer needed. |
5280 | Removed templates, and some minor fixes |
5250 | Removed newlines from prompt box |
4902 | Changed to use viewauth. Moved templates into user topics. |
4901 | Added templates in user webs support |
4897 | Fixes for disabling during preview; re-enabled old legacy parameters |
4889 | Chopped down from PeterMasiar version, removing several parameters, savecomment script, changing way templates are done. Major rewrite, atcherly. |
4882 | Update from PeterMasiar's 2.0 version, plus documentation and small code improvements. |
4745 | 06 Mar 2002 initial commit |
Perl Version: | >= 5.6.1 |
Plugin Home: | TWiki:Plugins/CommentPlugin |
Feedback: | TWiki:Plugins/CommentPluginDev |