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


== Usage ==

The UserGroups extension provides three custom tags. All of them refer to the 
first category group the containing page belongs to.

* <groupmemberlist>: includes a list of group members
* <groupmessagebutton>: includes a button to message the group members
* <groupjoinbutton>: includes a join/leave button

=== Filtering and formatting ===

You can provide options to control the listing of the <groupmemberlist> tag 
(for example, 20 entries and ordering by member's activity in the group):

	<groupmemberlist limit="10" orderbyactivity="true" />


For a full list of options, see below.


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

* limit         the maximum number of entries to show

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

* showspecialpagelink show a link to the special page listing all group members
                ("true" or "false", default is "false").