You are here: System » RevCommentPlugin

RevCommentPlugin

This plugin allows entry of a short summary of changes made to a topic for a new revision. This summary can be displayed e.g. in a history page of the topic or on the WebChanges page of a web. Changes may also be marked as "minor" by using the "Quiet save" button.

Since in Foswiki it is possible to make several changes within the edit lock time (normally 60 minutes) which are accumulated in only one new revision, it is also possible to have several comments for one revision.

Furthermore, adding or updating an attachment may also trigger an automatic comment for the current revision. This behaviour can be switched on or off with the help of the preference variable ATTACHMENT_COMMENTS (see below).

Syntax - Show previous comments

Write %REVCOMMENT{attributes}% anywhere in a topic.

Parameters

  • The following standard attributes are recognized
Name Description Default
web Web where topic exists current web
topic Name of topic current topic
rev Revision latest revision
delimiter Delimiter between 2 comments for the same revision </li><li>
pre Text before the first comment <ul><li>
post Text after the last comment </li></ul>
minor Text to print for a minor change (minor)
(The text for the pre and post parameters will only be printed if the list of comments is not empty.)
  • For your convenience, you can use [] instead of {} and '' instead of " inside other parameters.

Entering new comments

If the skin setting is enabled, a text input field named comment will be added to the Edit screens. Enter your comment when you save your edits, and it will be saved in the topic.

Examples

  • %REVCOMMENT% shows the comments for the current revision.

if you have RevCommentPlugin enabled, you should see a comment here:
  • New version 2.0 of this extension.

  • Example search results:
    ExampleWebChanges.png


  • If you have also the HistoryPlugin installed, the history of a topic may look like this:

  • Example History:
    ExampleHistory.png

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %REVCOMMENTPLUGIN_SHORTDESCRIPTION%

  • Debug plugin: (See output in working/logs/debug.log)
    • Set DEBUG = 0

  • List also new or updated attachments:
    • Set ATTACHMENT_COMMENTS = 1

Note that this extension now ships with 4 templates, and requires a SKIN override to incorporate this extension. Set the SKIN in SitePreferences.
  • For a Foswiki 2.0 system, Set SKIN = revcomment,natedit,pattern
  • For a Foswiki 1.1 system, Set SKIN = revcom11,pattern

Customization

Templates

The comment input field and displayed comments are added via skin template overrides.

  • Either revcomment or revcom11 substituted for <skin>:
    templates/edit.<skin>.tmpl
    Adds the revcomment parameter to the older Foswiki editor (Plain Text and TinyMCE.)
    templates/edittoolbar.<skin>.tmpl
    Adds the revcomment parameter to the NatEdit editor.
    templates/oopshistory.<skin>.tmpl
    Incorporates the revision comments into the topic history displayed by HistoryPlugin.
    templates/search.<skin>.tmpl
    Adds the revision comments to the default search

If you are using other skins than the pattern, you will need to fit these template overrides into your site's skin. These templates add a textfield to the Editor interface:
<input class='foswikiInputField' type='text' style='width:50%' name='revcomment' id='revcomment' />

CSS

Most of the CSS used to display comments is already embedded in the PatternSkin styles.css and colors.css A small amount of CSS is also contained in-line in the oopshistory template.

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

  • Test if the installation was successful:
    • Add the SKIN setting to enable the template modifications.
    • Create a topic in your Sandbox web. Add a %REVCOMMENT% macro to the topic, and save it with a comment.
    • If you have also the HistoryPlugin installed, view the history of the topic you just created. It should contain the comment.

Plugin Info

Change History:  
01 Sep 2015 (2.01) Foswikitask:Item13657: Regex issues on perl 5.22
15 Aug 2015 (2.00) Foswikitask:Item11068: RevCommentplugin conflicts with CommentPlugin
Foswikitask:Item13619: Add compatibility for Foswiki 2.0
Foswikitask:Item12880: Preserve rev-comment input across preview
11 Nov 2011 Item11249 - added registerMETA
22 Jan 2009: Kenneth Lavrsen - Added the two example images as attachments to the topic so they also get uploaded to foswiki.org. No need to upgrade from 08 Dec 2008 version if you already installed that.
08 Dec 2008: Kenneth Lavrsen: Changed the author to myself. JChristophFuchs is the original author but announced in 2006 that he no longer maintains this plugin. So now I officially take the task as maintainer. Plugin is changed to Foswiki namespace and tested and works under Foswiki 1.0.0. Policy is now feel free to modify but please do not break compatibility.
14 Apr 2006: <noautolink> added to default pre/post rendering output of REVCOMMENT tag
14 Apr 2006: Minor update for Dakar 4.0.2
22 Apr 2005: Initial version
Related Topics: DefaultPreferences, SitePreferences, Plugins
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 NCSS Leaders-Board? Send feedback