========   Favorite Forums Module v5.2.1.04  ========
Created by Joe Curia (azumandias _ at _ hotmail.com)
Original phorum coding by the Phorum Development Team (http://www.phorum.org)

========        Brief Description         ========
This module allows a user to select favorite forums to be shown together in a 
"My Favorite Forums" folder at the top of the index page.  The module supports 
selection of the favorite forums both from the Control Center under Forum 
Settings and also from the index and list pages.  However, the links for the 
index and list pages will need to be added to their respective templates. 
Instructions for doing so can be found below.  All links and headers can be 
customized for any language by following the language customization 
instructions below.

========           Installation           ========
After copying the module files and enabling the module, users will be able to 
select favorite forums by going to their Control Center -> Forum Settings page. 
If you would like to enable "Add To Favorites" and "Remove From Favorites" you 
will need to add some code to your templates index_new.tpl, index_classic.tpl, 
and list.tpl.  The simplest way to do this is to copy the "Mark Read" sections 
of code and duplicate them, changing MARK_READ to ADD_FAVORITE and 
REMOVE_FAVORITE, and LANG->MarkForumRead to 
LANG->phorum_mod_favorite_forums->AddToFavorites and 
LANG->phorum_mod_favorite_forums->RemoveFromFavorites respectively.  For the 
Emerald template and others based off of it, you will also want to remove the 
class="icon icon-tag-green" from the anchor to avoid duplicating the Mark Read 
icon. So, if you are using the Emerald template, your index_new.tpl will look 
something like this:
{IF FORUMS->URL->MARK_READ}<a class="icon icon-tag-green" href="{FORUMS->URL->MARK_READ}">{LANG->MarkForumRead}</a>&nbsp;&nbsp;&nbsp;{/IF}
<!-- Added for Favorite Forums mod -->
{IF FORUMS->URL->ADD_FAVORITE}<a href="{FORUMS->URL->ADD_FAVORITE}">{LANG->phorum_mod_favorite_forums->AddToFavorites}</a>{/IF}
{IF FORUMS->URL->REMOVE_FAVORITE}<a href="{FORUMS->URL->REMOVE_FAVORITE}">{LANG->phorum_mod_favorite_forums->RemoveFromFavorites}</a>{/IF}

And your list.tpl will look something like this:
{IF URL->MARK_READ}
    <a class="icon icon-tag-green" href="{URL->MARK_READ}">{LANG->MarkForumRead}</a>
{/IF}
<!-- Added for Favorite Forums mod -->
{IF URL->ADD_FAVORITE}<a href="{URL->ADD_FAVORITE}">{LANG->phorum_mod_favorite_forums->AddToFavorites}</a>{/IF}
{IF URL->REMOVE_FAVORITE}<a href="{URL->REMOVE_FAVORITE}">{LANG->phorum_mod_favorite_forums->RemoveFromFavorites}</a>{/IF}

To customize the links and headers for your language, copy the english.php in 
this mods "lang" folder and rename it so that it has the same name as your main 
language file (found in the "include/lang" folder).  Then edit the new language 
file with the appropriate translations.  If you do create a custom language 
file, please considering uploading it to this module's thread on the Phorum 
website for others to use.

========                Todo              ========
- Add support for the Tabbed Emerald template 

- Add features as they are requested.
 
========               Files              ========
\favorite_forums\
    Changelog
    favorite_forums.php
    info.txt
    README
    lang\
        english.php
    templates\
        simple_rounded\
            settings.php