--------------------------------------------------------------------------
README for the Activity extension
Copyright © 2010 Jan Böhme, ideas-ketch.com
Licenses: GNU General Public Licence (GPL)
          GNU Free Documentation License (GFDL)
--------------------------------------------------------------------------

The Activity extension was written deriving from the News extension by Daniel
Kinzler ( <http://mediawiki.org/wiki/Extension:News> ) and is released under the
GNU General Public Licence (GPL).


== Installing ==

Copy the Activity directory into the extensions folder of your
MediaWiki installation. Then add the following line to your
LocalSettings.php file (near the end):

  require_once( "$IP/extensions/Activity/Activity.php" );

== Usage ==

The Activity extension provides a custom tag:
* <activity>: this includes a list of recent activity on the wiki or the given
category group


=== Filtering and formatting ===

You can provide options to control the listing (for example, 20
entries and no minor edits):

	<activity limit="20" nominor/>


For a full list of options, see below.


=== Options ===
The following options (tag attributes) can be used to controll the output of the
<activity> tag:

* unique        show actions of the same user on the same object only if the
                the time difference between them is >1h ("true" or "false",
                default is "true").

* limit         the maximum number of entries to show

* categories    limit results to the given categories. Multiple categories can
                be given separated by "|"; Intersections of categories are not
                supported. Recursion into subcategories is not supported.

* namespaces    limit results to the given namespaces. Multiple namespaces can
                be given separated by "|"; you can use "0", "-" or "main" to
                refer to the default namespace.

* nominor       hide minor edits ("true" or "false", default is "false"). If
                given, the edit shown may not refer to the current revision. 

* nobot         hide bot edits ("true" or "false", default is "true"). If
                given, the edit shown may not refer to the current revision. 

* onlynew       show only page creations ("true" or "false", default is
                "false"). If given, the edit shown may not refer to the current
                revision. 

* pagetalk      show activity on article's talk pages ("true" or "false", default is
                "true").

* grouptalk     show activity on group's talk pages ("true" or "false", default is
                "true"). CURRENTLY UNSUPPORTED

* showfiles     show file uploads and related activity ("true" or "false", default is
                "true").

* showarticles  show edits of 'normal' wiki articles ("true" or "false", default is
                "true").

* showmemberships  show when somebody joins the group ("true" or "false", default is
                "true").