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).
anywhere in a topic.
|| web where topic exists
|| current web
|| name of topic
|| current topic
|| latest revision
|| delimiter between 2 comments for the same revision
|| text before the first comment
|| format string for each revision comment
<li> $comment $minor
|| text after the last comment
|| text to print for a minor change
The text for the pre
parameters will only be printed if the list of comments is not empty.
If the skin setting is enabled, a text input field named
added to the Edit screens. Enter your comment when you save your edits, and
it will be saved in the topic.
%REVCOMMENT% shows the comments for the current revision.
if you have RevCommentPlugin
enabled, you should see a comment here: %REVCOMMENT%
If you have also the HistoryPlugin
the history of a topic may look like this:
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
The comment input field and displayed comments are added via skin template overrides.
revcom11 substituted for
- Adds the
revcomment parameter to the older Foswiki editor (Plain Text and TinyMCE.)
- Adds the
revcomment parameter to the NatEdit editor.
- Incorporates the revision comments into the topic history displayed by HistoryPlugin.
- 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' />
Most of the CSS used to display comments is already embedded in the PatternSkin
A small amount of CSS is also
contained in-line in the
Third plugins may register a revision comment using the
api. See the PerlDoc
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. "Extensions Operation and Maintenance" Tab -> "Install, Update or Remove extensions" Tab. Click the "Search for Extensions" button.
Enter part of the extension name or description and press search. Select the desired extension(s) and click install. If an extension is already installed, it will not
show up in the
You can also install from the shell by running the extension installer as the web server user: (Be sure to run as the webserver user, not as root!)
perl tools/extension_installer <NameOfExtension> install
If you have any problems, or if the extension isn't available in
, then you can still install manually from the command-line. See https://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.