Module  : Check Subscriptions
Version : 1.0.0
Author  : Tom Ierna

This module uses a user's subscription data (followed topics) to
drive a "Check Subscriptions" workflow.

A "Check Subscriptions" link placed on any page will cause the module
to see if any of the user's followed topics have new messages. If one
does, it will redirect to the first unread message of the followed topic.

Each subsequent click of the link will redirect to the next unread topic,
until there are no messages unread in any followed topics, whereupon the
user will be presented with a message telling them there are no new messages.


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

- Unpack the archive;

- Move the directory "check_subscriptions" 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 "Check Subscriptions".

- Templates must be configured to show the Check Subscriptions link.
  Alter your templates to suit your needs.


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

To display the link to check subscriptions 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->CHECK_SUBS}
     The URL for the check subscriptions behavior.

  {LANG->mod_check_subscriptions->CheckSubscriptions}
     The text to use for the link / button for the check
     subscriptions behavior.

Example template code for adding a hyperlink to a template:

   <a href="{URL->CHECK_SUBS}">
     {LANG->mod_check_subscriptions->CheckSubscriptions}
   </a>

In my installation, I've put a "Check Subscriptions" link in
the "nav" div on the "index_new.tpl", "read.tpl" and "list.tpl"
templates.

A user can also bookmark the URL for the module.

It is probably a good idea to place the check subscriptions link within
template language that only makes the link visible if a user is logged in.
