Line: 1 to 1 | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Added: | |||||||||||||||||||||||||||||||
> > | |||||||||||||||||||||||||||||||
Comment PluginThis plugin allows users to quickly post comments to a page without an edit/preview/save cycle. ( Discussion in TWiki:Plugins/CommentPluginDev![]() | |||||||||||||||||||||||||||||||
Added: | |||||||||||||||||||||||||||||||
> > | Note: this version of the CommentPlugin will not work with TWiki versions released prior to June 2005 | ||||||||||||||||||||||||||||||
On this page:
Features | |||||||||||||||||||||||||||||||
Line: 21 to 24 | |||||||||||||||||||||||||||||||
The following attributes are recognised
| |||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Added: | |||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||
Positioning the comment%COMMENT supports several ways to specify where a comment should be inserted in the target topic. This is referred to as the location of the comment. | |||||||||||||||||||||||||||||||
Line: 53 to 57 | |||||||||||||||||||||||||||||||
Warning of course, if a user's comment contains the string "Flights of Fancy" they may and up changing the location for the next comment! Also, if you use a tag in the location, then you've just inserted another tag in the page that contains the %COMMENT ! So be very careful how you specify the RE for location . Note that the RE is matched using perl "multiple line" mode, so ^ and $ match the start of a line and the end of a line respectively. | |||||||||||||||||||||||||||||||
Added: | |||||||||||||||||||||||||||||||
> > | I look forward to someone leveraging this feature to create - for example - threaded conversations using %COMMENT . | ||||||||||||||||||||||||||||||
If you specify an anchor and a location , the anchor will be ignored.
Default templates | |||||||||||||||||||||||||||||||
Added: | |||||||||||||||||||||||||||||||
> > | Templates are used to define the "comment style" i.e. how comments appear in the page. The default is to add comments in "Blog like" style using bulleted lists, with the most recent comment at the top, but many other styles are available such as tables or Wiki thread mode comments. It is easy to define your own customer styles as well. | ||||||||||||||||||||||||||||||
A set of default comment templates are shipped with the plugin. These are:
| |||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||
Your local installation may add more template types as well - see Customisation, below. | |||||||||||||||||||||||||||||||
Line: 73 to 82 | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Deleted: | |||||||||||||||||||||||||||||||
< < | The plugin picks up its templates from a standard TWiki template file, named "comments". This allows different templates to be defined for different TWiki skins. This template file may include other template files, or may include a topic from a user web (this is an extension to the normal handling of %TMPL:INCLUDE described in the documentation). The shipped plugin defines default templates in comments.tmpl and then includes the topic CommentsTmpl. If you want to define your own templates, add them to UserTemplates. Note that you can use %TMPL:INCLUDE in this file to include other files of templates. Note also that if you want to override any of the default templates shipped with the plugin, you can simply do so by defining them in UserTemplates, and they will replace the installed versions. | ||||||||||||||||||||||||||||||
To define a comment type, you have to provide two simple template definitions in the template file; one for the prompt box, and one for the generated output. If we have a template type "mytype", these are named PROMPT:mytype and OUTPUT:mytype respectively. See comments.tmpl in the templates directory for examples. | |||||||||||||||||||||||||||||||
Added: | |||||||||||||||||||||||||||||||
> > | 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. By default, this template includes the topic CommentsTemplate, which contains all the shipped standard templates and in turn includes TWiki.UserCommentsTemplate. This allows for several levels of customisation:
![]() %TMPL:INCLUDE to include other files of templates. | ||||||||||||||||||||||||||||||
The
The | |||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||
< < | Only the input fields of the form need be defined. The plugin automatically generates the >form< and >:/form< tags. Note that you must define a "submit" button if you want the form to work! | ||||||||||||||||||||||||||||||
> > | Only the input fields of the form need be defined. The plugin automatically generates the >form< and >:/form< tags, unless you specify noform="on" , in which case you have to provide them yourself. Note that you must define a "submit" button if you want the form to work! | ||||||||||||||||||||||||||||||
If an attribute is given to the %COMMENT tag that is not one of the standard attributes, then that attribute is taken as the name of a parameter to be expanded in the PROMPT template. Expressions in the template of the form % param| default% (e.g. %rows|3% , %button|Push me% ) are expanded to the values given in the %COMMENT . For example, if the PROMPT template 'example' contains: | |||||||||||||||||||||||||||||||
Line: 89 to 104 | |||||||||||||||||||||||||||||||
and the %COMMENT tag is:
| |||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||
< < | %COMMENT{type="example" rows="5" cols="20"}% | ||||||||||||||||||||||||||||||
> > | %COMMENT{type="example" cols="75"}% | ||||||||||||||||||||||||||||||
then the template will be expanded as
| |||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||
< < | <textarea rows=5 cols="20" value="Rubbish"> | ||||||||||||||||||||||||||||||
> > | <textarea rows="3" cols="75" value="Rubbish"> | ||||||||||||||||||||||||||||||
As well as support for all the usual TWiki variables in templates, the following special variables are supported in the PROMPT definition:
| |||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||
The
The | |||||||||||||||||||||||||||||||
Line: 112 to 127 | |||||||||||||||||||||||||||||||
DEFAULT_TYPE | |||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||
< < |
Important Note regarding LocksThe plugin checks if the page is locked for edit. When a locked page is displayed in 'view' mode, comment input is automatically disabled. Note that if the page was read long time ago, it's possible that page was locked by another user after it was read, and the lock is still outstanding. In this case, comments cannot be saved, and you will be redirected to a "topic is locked" page. You then have two options:
%COMMENT . When the target page is known to be locked, the PROMPT form is automatically disabled. | ||||||||||||||||||||||||||||||
> > | All the usual TWikiVariables that can be used in a topic template can also be used in an OUTPUT template. See TWikiVariables for details. | ||||||||||||||||||||||||||||||
Settings
| |||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||
Plugin Installation Instructions | |||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||
< < | * Make sure you have the TWiki:Plugins/SharedCode![]() ![]()
%COMMENT edit box below here.
| ||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||
Plugin Info | |||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||
< < |
| ||||||||||||||||||||||||||||||
> > |
| ||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Changed: | |||||||||||||||||||||||||||||||
< < | -- TWiki:Main/DavidWeller![]() -- TWiki:Main/PeterMasiar ![]() -- TWiki:Main/CrawfordCurrie ![]() | ||||||||||||||||||||||||||||||
> > | -- TWiki:Main/CrawfordCurrie![]() |
Line: 1 to 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Added: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
> > | Comment PluginThis plugin allows users to quickly post comments to a page without an edit/preview/save cycle. ( Discussion in TWiki:Plugins/CommentPluginDev![]() On this page:
FeaturesInserts an edit box into the page that allows users to type in and save comments. Comments can be made
Syntax RulesWrite the command%COMMENT{ attributes }% anywhere in a TWiki topic. %COMMENT% is also legal.
The following attributes are recognised
Positioning the comment%COMMENT supports several ways to specify where a comment should be inserted in the target topic. This is referred to as the location of the comment.
Location relative to
The default location is the |
Template type | Description |
---|---|
top |
Comments, signed and dated, added at top of the topic (the anchor is ignored) |
bottom |
Comments, signed and dated, added at end of the target topic (the anchor is ignored) |
above |
Comments, signed and dated, added immediately before the target anchor, or the %COMMENT if no anchor is specified |
below |
Comments, signed and dated, added immediately below the target anchor, or the %COMMENT if no anchor is specified |
tableprepend |
Comments, signed and dated, formatted as an HTML table row, added below the anchor (which must be in an HTML <table>) |
tableappend |
Comments, signed and dated, formatted as an HTML table row, added above the anchor (which must be in an HTML <table>) |
%TMPL:INCLUDE
described in the documentation). The shipped plugin defines default templates in comments.tmpl
and then includes the topic CommentsTmpl. If you want to define your own templates, add them to UserTemplates. Note that you can use %TMPL:INCLUDE
in this file to include other files of templates. Note also that if you want to override any of the default templates shipped with the plugin, you can simply do so by defining them in UserTemplates, and they will replace the installed versions.
To define a comment type, you have to provide two simple template definitions in the template file; one for the prompt box, and one for the generated output. If we have a template type "mytype", these are named PROMPT:mytype
and OUTPUT:mytype
respectively. See comments.tmpl
in the templates directory for examples.
PROMPT
template PROMPT
template defines the contents of an HTML form that is used to capture the comment. This form invokes the comment generator when submitted. Parameters to the comment generator are defined using standard HTML input fields, such as input
, textarea
and select
. The user enters values for these parameters, and these are then available when the OUTPUT
template is expanded, in the form of %URLPARAM%
s.
Only the input fields of the form need be defined. The plugin automatically generates the >form<
and >:/form<
tags. Note that you must define a "submit" button if you want the form to work!
If an attribute is given to the %COMMENT
tag that is not one of the standard attributes, then that attribute is taken as the name of a parameter to be expanded in the PROMPT
template. Expressions in the template of the form %
param|
default%
(e.g. %rows|3%
, %button|Push me%
) are expanded to the values given in the %COMMENT
. For example, if the PROMPT
template 'example' contains:
<textarea rows=%rows|3% cols="%cols|50%" value="%tval|Rubbish%">and the %COMMENT tag is:
%COMMENT{type="example" rows="5" cols="20"}%then the template will be expanded as
<textarea rows=5 cols="20" value="Rubbish">As well as support for all the usual TWiki variables in templates, the following special variables are supported in the
PROMPT
definition:
Variable | Description |
---|---|
%MESSAGE% |
A helpful generated message, either a lock message or a reminder to refresh. |
%DISABLED% |
Set to 'disabled' when you cannot comment (see Important Note regarding Locks, below). |
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
%COMMENT
. When the target page is known to be locked, the PROMPT
form is automatically disabled.
CommentPlugin.zip
in your twiki installation directory. Content: File: | Description: |
---|---|
data/TWiki/CommentPlugin.txt | Plugin doc page (this page) |
data/TWiki/CommentsTmpl.txt | Example user templates |
templates/comments.tmpl | Master comment templates |
lib/TWiki/Plugins/CommentPlugin.pm | Plugin Perl module |
lib/TWiki/Plugins/CommentPlugin/Comment.pm | Plugin Perl module |
lib/TWiki/Plugins/CommentPlugin/Templates.pm | Plugin Perl module |
lib/TWiki/Plugins/CommentPlugin/test.zip | Tests |
lib/TWiki/Plugins/CommentPlugin/build.pl | Build file |
viewauth
script to authenticate the user. As described in TWikiAccessControl, copy the view
script to viewauth
(or better, create a symbolic link) and add viewauth
to the list of authenticated scripts in the .htaccess
file.
%COMMENT
edit box below here.
Plugin Author: | v1.0 TWiki:Main/DavidWeller![]() ![]() ![]() |
Plugin Version: | 3.0 |
Change History: | <-- Most recent first -->3.003 11 Apr 2004: Minor line termination problem fixed, and "security" hyphen on standard comment removed and replaced with a bulleted list. |
3.002 6 April 2004: Applied patches (thanks Peter Thoeny) for multiple comment adding, BOTTOM and TOP inside meta-data, and moved example to Sandbox. | |
3.001 13 March 2004: Modified to use viewauth save technique (safer), add nonotify parameter, move templates fully into topics, with a hook for site-specifics, support %COMMENT%, internationalisation fixes | |
3.000 18 Feb 2004: TWiki:Main/CrawfordCurrie![]() |
|
7 Feb 2004: TWiki:Main/CrawfordCurrie![]() |
|
23 Sep 2003 TWiki:Main/PeterMasiar![]() |
|
15 July 2003: TWiki:Main/PeterMasiar![]() |
|
5 March 2002 Bug fixes, TWiki:Main/JonLambert![]() |
|
24 Feb 2002 added a few more user requests, made "English" text configurable | |
4 Dec 2001: 1.01 release, changed name to CommentPlugin, added $button var, changed textarea WRAP setting to "soft" | |
30 Nov 2001: Initial version | |
Dependencies: | |
Perl Version: | 5.0 |
Plugin Home: | TWiki:Plugins/CommentPlugin![]() |
Feedback: | TWiki:Plugins/CommentPluginDev![]() |