MetaCommentPlugin

An easy to use comment system

This is YACS (yet another comment system) which tries

  • (a) to be easy to use
  • (b) to scale up to lots of comments
  • (c) to provide different layouts and commenting requirements

MetaCommentPlugin allows to easily add commenting to any topic. Discussiosn can either be displayed in linear or threaded mode. Different comment styles and layouts can easily be created and switched from one to the other. Comments can be edited and deleted inline easily. Commenting can be enabled independently from the normal change access rights to a topic while they are still stored as meta data to a topic. That way a keyword search matching on different comments of the same discussion will generate a hit on the discussion itself in a natural way.

Note, that this plugin is in alpha state as some features are still missing:

  • implement an approval system
  • implement a RECENTCOMMENTS macro to display a list of all activities in a forum
  • extend METACOMMENTS to display/suppress comments that are approved/need approvement

Screenshot

MetaCommentSnap1.jpeg

Data Model

Each comment is stored into a META:COMMENT field of a topic with properties

  • name: id of the comment, used in ref for threaded comments
  • author: WikiName of the author of this comment
  • date: timestamp when this comment was created
  • modified: timestamp when this comment was last modified
  • ref: name of another comment within the same thread this comment is a subcomment of
  • text: the comment text
  • title: title text of this comment

Syntax

METACOMMENTS

Renders a discussion on a given topic

%METACOMMENTS{
  topic="..."
  ...
}%

Parameters:

  • topic: the topic to render the discussion for, defaults to the current topic
  • header: string prepended to the output
  • footer: string appended to the output
  • format: format string used to render each comment, defaults to

    $title

    $text
  • template: template to be used instead of the inline format parameter
  • separator: separats the list of comments
  • subheader: string prepended to the list of subcommnets, defaults to <div class='cmtSubComments'>
  • subfooter: string appended to the list of subcommnets, defaults to </div
  • subformat: format string used for subcomments, defaults to the value of the format parameter
  • ref: only list comments that are a subcomments of the given comment
  • skip: number of comments to skip in the list, useful for pagination
  • limit: maximum number of comments to list, useful for pagination
  • singular: title used when only one comment is present, defaults to One comment
  • plural: title when there are more than one comment, defaults to "$count comments
  • mindate: minimum date of a comment to be displayed
  • maxdate: maximum date of a comment to be displayed
  • threaded: switch on/off threaded rendering, comments will be rendered recursively

RECENTCOMMENTS

todo

Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Info

Author(s): Foswiki:Main/MichaelDaum
Copyright ©: 2009-2011, Michael Daum http://michaeldaumconsulting.com
License: GPL (Gnu General Public License)
Release: 0.92
Version: 11515 (2011-04-20)
Change History:  
20 Apr 2011: fixed error in regular expression
15 Apr 2011: using CPAN:JSON to properly encode json-rpc data; fixed recoding of received data to the site's own charset; improved the way photos are gathered
Dependencies:
NameVersionDescription
JSON>=0Required.
Foswiki::Plugins::ZonePlugin>=3.1Required. required for Foswiki < 1.1
Home page: Foswiki:Extensions/MetaCommentPlugin
Support: Foswiki:Support/MetaCommentPlugin

Print version |  PDF  | History: r0 | 
Topic revision: r1 - 12 Feb 2010 - 20:58:39 - ProjectContributor
 

TUTWiki

This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding TUTWiki? Send feedback