Module  : Top Users
Version : 2.0.3
Authors : orginal concept by Thomas Seifert (thomas@phorum.org)
          updated by Amilcar do Carmo Lucas (amilcar@kdevelop.org)
          new version 2.0.0 by Steve Healy
          (with code borrowed heavily from modules by Maurice Makaay)

This module implements an addon page, which displays users statistics
to the user. The user can:

 * choose how many users should be shown per page;
 * show users sorted by total number of posts, name, or last active date.

For running this mod, you need Phorum 5.2.2-beta or later. It will not
work for earlier versions of Phorum.


Installation:
-------------

- Unpack the archive;

- Move the directory "topusers" to the directory "mods"
  within your Phorum installation;

- Login as administrator in Phorum's administrative interface and
  go to the "Modules" section;

- Enable the module "Top Users".

- Templates must be configured to show the link to the Top Users page.
  Alter your template to suit your needs.


Template customization:
-----------------------

To display the link to the Top Users page on various Phorum pages,
you will have to edit the Phorum template files. In these template files,
you can use the following template variables:

  {URL->TOPUSERS}
     The URL for the Top Users page

  {LANG->mod_topusers->TopUsers}
     The text to use for the link / button that takes the user to the
     Top Users page.


Example template code for adding a hyperlink to a template:

    <a href="{URL->TOPUSERS}">
        {LANG->mod_topusers->TopUsers}
    </a>

if you are adding the link to the Emerald template (the default Phorum 5.2
template) or a template that is based on Emerald, then you can also use
the following code to make it show an icon in front of the link.

    <a class="icon icon-group-add" href="{URL->TOPUSERS}">
        {LANG->mod_topusers->TopUsers}
    </a>
