HistoryPlugin < System

You are here: Foswiki>System Web>Plugins>HistoryPlugin (10 Apr 2011, ProjectContributor) (raw view)EditAttach
---+ History Plugin

Shows a complete history of a topic.

The output can arbitrarily be formatted. An example for a Wikipedia-like history is included.

When using PatternSkin enabling the !HistoryPlugin changes the "History" link in the bottom action bar so it opens a page with a nice user interface where you can select the versions to compare.

With other skins for Foswiki you will need to tweak the templates.

If [[Foswiki:Extensions.CompareRevisionsAddOn][CompareRevisionsAddOn]] is installed and activated the "History" user interface will allow you to choose how the changes are rendered (interweaved vs side-by-side, and context).

If [[Foswiki:Extensions.RevCommentPlugin][RevCommentPlugin]] is installed and activated the "History" page will show the comments entered for each revision.

This plugins is designed to work together with !CompareRevisionsAddOn and !RevCommentPlugin but works well on its own or with just one of the two other plugins.

---++ Syntax Rules
Syntax: =%<nop>HISTORY{ _attributes_ }%=

%INCLUDE{"%SYSTEMWEB%.VarHISTORY" section="history_attributes"}%

---++ Examples

The call %<nop>HISTORY% shows a simple list of available revisions like%BR%
<pre>
r3 - 17 Feb 2005 - 09:56 - AnUser
r2 - 31 Dec 2004 - 10:22 - AnotherUser
r1 - 15 Nov 2003 - 01:23 - YetAnotherUser
</pre>

For a more complex example see the attached =oopshistory.tmpl= which also allows the comparison of two selected revisions. 

Example screenshot of the topic history with !HistoryPlugin enabled and working with !CompareRevisionsAddOn and !RevCommentPlugin.

<div class="foswikiImage"><img src="%ATTACHURLPATH%/screenshot.png" alt="screenshot" width='785' height='592' /></div>

---++ Plugin Installation Instructions

__Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where Foswiki is running. 

   * Download the ZIP file from the Plugin web (see below)
   * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
   | *File:* | *Description:* |
   | ==data/System/HistoryPlugin.txt== |  (noci) |
   | ==data/System/VarHISTORY.txt== |  (noci) |
   | ==lib/Foswiki/Plugins/HistoryPlugin.pm== |  (noci) |
   | ==pub/System/HistoryPlugin/screenshot.png== |  (noci) |
   | ==templates/oopshistory.tmpl== |  (noci) |

   * Visit =configure= in your Foswiki installation, and enable the plugin in the {Plugins} section.
   * Test if the installation was successful:
      * Here should appear the history of this document inline: 
        %HISTORY{"      r1.$rev - $date - $wikiusername%BR%"}%
      * Show the history of Main.WikiUsers :%BR%
        %SCRIPTURL{oops}%/Main/WikiUsers?template=oopshistory

---++ Plugin Info
<!--
      * Set SHORTDESCRIPTION = Shows a complete history of a document
-->

|  Plugin Author: | Foswiki:Main.KennethLavrsen |
|  Copyright &copy;: | 2006, !JChristophFuchs; 2008-2012 Kenneth Lavrsen and Foswiki Contributors |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Version: | 1.11 |
|  Release: | 1.11 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  28 Nov 2012: | 1.11 Version released with Foswiki 1.1.6. Change to perl version strings |
|  11 Apr 2011: | 1.10 Version released with Foswiki 1.1.3. Only a minor change related to how the plugin is being upgraded |
|  13 Mar 2011: | 1.9 Arthur Clemens: added parameter =versions= as a more versatile alternative to =rev1=, =rev2=, =nrev= and =reverse=. |
|  13 Mar 2011: | 1.8 Arthur Clemens: fix rendering of =REVINFO= date and time parameters; add unit tests. |
|  27 Dec 2010: | 1.7 Arthur Clemens: update of screen layout. |
|  31 Jul 2010: | 1.6 Paul Harvey: Foswikitask:Item9415 - Documentation updates | 
|  09 Feb 2009: | 1.5 Kenneth Lavrsen: Small cosmetic updates. Changed the author name to non liked to avoid bogus links to Main.loginname. Changed some CSS names to Foswiki that I missed in 1.4 |
|  08 Dec 2008: | 1.4 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 | 
|  09 Dec 2007: | 1.3 Kenneth Lavrsen: Restored the features that were lost in revision 1.1 including: Showing comments made by !RevCommentPlugin, selection of render styles "interweave" and "side by side" provided by !CompareRevisionsAddOn, and link to rdiff history. Restored compatibility with TWiki-4.1 which means removing the dependency of 4.2 only CSS feature. Updated the default rev format to 4.X format. |
|  13 Nov 2007: | 1.2 Michael Daum: removed cruft from plugin, \
                  updates to use modern TWiki APIs, \
                  added some more flexibility to create a diff interface, \
                  removed plugin topic options |
|  07 Nov 2007: | 1.1 Arthur Clemens: updated to TWiki 4.2; improved user interface.  |
|  19 Jan 2007: | 1.002 Corrected coding error that causes the plugin to fail with HISTORY tag in topic |
|  9 Apr 2006: | 1.001 Updated for new <nop>PatternSkin in [[http://TWiki.org/cgi-bin/view/Codev/TWikiRelease04x00x02][TWikiRelease04x00x02]] |
|  17 Feb 2005: | Initial version |
|  Foswiki Dependency: | $Foswiki::Plugins::VERSION 1.024 |
|  CPAN Dependencies: | none |
|  Other Dependencies: | none |
|  Perl Version: | 5.008 |
|  Plugin Home: | http://foswiki.org/Extensions/%TOPIC% |
|  Support: | http://foswiki.org/Support/%TOPIC% |

__Related Topics:__ %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences, [[%SYSTEMWEB%.Plugins][Plugins]]
Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
png	screenshot.png	manage	70.4 K	13 Mar 2011 - 02:05	AdminUser
Topic revision: r1 - 10 Apr 2011, ProjectContributor
System
Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback