TWiki > TWiki > ContributorsPlugin	TWiki webs: Main | TWiki | Sandbox?
	TWiki . { Welcome | Register | Changes | Topics | Index | Search | Go }

Contributors Plugin

• showing only up to a give revision
• showing only a given number of lines
• using a custom format
• using a custom header.

The %CONTRIBUTORS% variable can be used in templates to automatically display who has edited a page and when.

Included with the plugin is a page (WebContributors) that allows the user to access the contributor history via a regular URL.

The WebContributors page is useful when publishing information with a license that requires attribution, such as several of the Creative Commons licenses. The people who create derivative works can then put a URL that embeds the web name, topic name, and the current revision number in their attribution notices.

Syntax Rules

Using the %CONTRIBUTORS% variable alone will expand to show the author, revision, and date of each edit of the current topic. Here's what it looks like"

• Main.guest -- Revision 1.1 on date Wed, 04 May 2005 02:30:50 GMT

The following arguments to %CONTRIBUTORS% are also allowed:

In the format string, the user can use the following variables:

In the header string, the user can use $n but no other variables (at the moment).

To use WebContributors, you pass a URL with the information you want in the query string. Note, however, that there are some differences:

• Instead of using topic, you must use page. If you use topic, then bin/view will display that topic instead of displaying WebContributors for that topic.
• Instead of using rev, you must use revision. If you use rev, then bin/view will expand that revision of WebContributors instead of expanding the current version of WebContributors.

Plugins Settings

• One line description which is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = This plugin gives a variable %CONTRIBUTORS% which gives information on all revisions of a given topic.

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Examples

• CarolynJohnston -- Revision 1.15 on date Sat, 24 Dec 2005 01:46:46 GMT
• CarolynJohnston -- Revision 1.14 on date Sat, 24 Dec 2005 01:37:16 GMT
• CarolynJohnston -- Revision 1.13 on date Thu, 04 Aug 2005 04:28:17 GMT
• CarolynJohnston -- Revision 1.12 on date Tue, 02 Aug 2005 01:57:35 GMT
• CarolynJohnston -- Revision 1.11 on date Tue, 02 Aug 2005 01:55:21 GMT
• CarolynJohnston -- Revision 1.10 on date Mon, 01 Aug 2005 05:02:05 GMT
• CarolynJohnston -- Revision 1.9 on date Mon, 01 Aug 2005 04:37:25 GMT

• -- Revision 1.20 on date Thu, 01 Jan 1970 00:00:00 GMT
• -- Revision 1.19 on date Thu, 01 Jan 1970 00:00:00 GMT
• -- Revision 1.18 on date Thu, 01 Jan 1970 00:00:00 GMT
• -- Revision 1.17 on date Thu, 01 Jan 1970 00:00:00 GMT
• -- Revision 1.16 on date Thu, 01 Jan 1970 00:00:00 GMT
• CarolynJohnston -- Revision 1.15 on date Sat, 24 Dec 2005 01:46:46 GMT
• CarolynJohnston -- Revision 1.14 on date Sat, 24 Dec 2005 01:37:16 GMT

• CarolynJohnston
• CarolynJohnston

Use %CONTRIBUTORS{web="TWiki" topic="TWikiPreferences" last="7" rev="1.20" format=" * $author$n" nodups="on"}% to get

• CarolynJohnston

Author	Date	Revision
CarolynJohnston	Sat, 24 Dec 2005 01:37:16 GMT	1.14
CarolynJohnston	Sat, 24 Dec 2005 01:46:46 GMT	1.15
	Thu, 01 Jan 1970 00:00:00 GMT	1.16
	Thu, 01 Jan 1970 00:00:00 GMT	1.17
	Thu, 01 Jan 1970 00:00:00 GMT	1.18
	Thu, 01 Jan 1970 00:00:00 GMT	1.19
	Thu, 01 Jan 1970 00:00:00 GMT	1.20

Plugin Installation Instructions

Plugin Installation Instructions

Note: You do not need to install anything on your Web browser to use this plugin. The installation instructions below are for installing this plugin on the TWiki server, and so only the TWiki system administrator needs to pay attention to them.

• Download the ZIP file from the Plugin web (see below)
• Unzip ContributorsPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/ContributorsPlugin.txt	Plugin topic
  data/TWiki/ContributorsPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/ContributorsPlugin.pm	Plugin Perl module
  data/TWiki/WebContributors.txt	Page to allow getting revision history from a URL
  data/TWiki/WebContributors.txt,v	Revision history of WebContributors

• Test if the plugin is correctly installed:
  • Check the above examples to see if the plugin operates as expected.

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin

-- TWiki:Main.AndreaSterbini - 27 Feb 2001
-- TWiki:Main.PeterThoeny - 21 Mar 2004
-- DuckySherwood^? - 10 Dec 2004