post development notes in Comment Plugin Dev?

• CommentPlugin
• Syntax Rules
• CommentPlugin Settings
  • Plugin Installation Instructions
  • Plugin Info

Comment Plugin

The Comment Plugin 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.

Syntax Rules

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)

Comment Plugin Settings

• 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
  • Set ROWS = 5
• Default number of columns in a COMMENT
  • Set COLS = 70" class="comments

• Default "submit button" text for COMMENT
  • Set BUTTONNAME = Додати коментар

• Default signature line
  • Set SIGNATURE = -- Main.guest - 12-бер-2010

• Default label for "mode" in a COMMENT
  • Set PREFIXMODENAME = before
  • Set PREFIXLABEL = Ваше повідомлення з'явиться перед цією формою у хронологічному порядку (новіші унизу)
    
  • Set POSTFIXMODENAME = after
  • Set POSTFIXLABEL = Ваше повідомлення з'явиться після цієї форми у зворотньому порядку (новіші зверху)
    

Plugin Installation Instructions

TWO WARNINGS

• WARNING 1: Anybody can refactor Comments, just like any other topic. Comment Plugin 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:

• 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 :

dfdfdsfjsdafj

-- Main.guest - 05-лис-2003

Plugin Info

Related Topics: TWiki Preferences, TWiki Plugins

-- David Weller? - 05 Mar 2002