post development notes in CommentPluginDev?
The CommentPlugin gives the ability to quickly post comments in forward/reverse
chronological order. Simply entering text and clicking on the Comment button will have your comments added before or after the form, including your name and date.
There are only five options with the Comment meta tag:
- rows: Any number > 0 will set the rows of the text area (default is 5)
- cols: Any number > 10 will set the columns of the textarea (default is 70)
- mode: The word "after" tells Comment to put the posted data after the form in reverse chronological order (default = "normal" chronological order)
- button: This lets you change the text of the submit button (default is "Add Comment")
- id: This gives a unique name for a COMMENT, in case you have more than one COMMENT tag in a topic (mandatory with > 1 COMMENT)
- Description:
- Set SHORTDESCRIPTION = Allows users to quickly edit a topic without going through the edit/preview/save cycle
- Default number of rows in a COMMENT
- Default number of columns in a COMMENT
- Default "submit button" text for COMMENT
- Set BUTTONNAME = Add Comment
- Default label for "mode" in a COMMENT
- Set PREFIXMODENAME = before
- Set PREFIXLABEL = Your post will appear before this form in chronological order (newest at bottom)
- Set POSTFIXMODENAME = after
- Set POSTFIXLABEL = Your post will appear after this form in reverse chronological order (newest at top)
TWO WARNINGS
- WARNING 1: Anybody can refactor Comments, just like any other topic. CommentPlugin knows nothing about what you've done once you have posted your comments.
- WARNING 2 (Installation warning): Because Plugins have no capability to handle form post-processing (from what I can see), I was left with no recourse but to create a
savecomment script in the bin directory. I will be delighted if one of the more seasoned developers could help fix this, but for now I guess it's in the "hack" category.
- Download the ZIP file from the Plugin web (see below)
- Unzip
CommentPlugin.zip in your twiki installation directory. Content:
| File: | Description: |
|---|
data/TWiki/CommentPlugin.txt | Plugin topic |
data/TWiki/CommentPlugin.txt,v | Plugin topic repository |
lib/TWiki/Plugins/CommentPlugin.pm | Plugin Perl module |
bin/savecomment | Plugin save script (HACK) |
- Check this topic here if the installation was successful
- Test if the plugin is correctly installed:
If installed correctly, you should see a 4 "Comment" form fields below here, not
the meta tag. Feel free to use this sequence of comments as a way to test the
"behaviour" of multiple comments with multiple modes. But please test it in ano
ther topic, preferably in the Test Web  :
Related Topics: TWikiPreferences, TWikiPlugins
-- DavidWeller? - 05 Mar 2002
|
|
