/*-------------------------------------------------------+
| PHP-Fusion Content Management System
| Copyright (C) 2002 - 2011 Nick Jones
| http://www.php-fusion.co.uk/
+--------------------------------------------------------+
| Filename: readme.txt
| Version: 1.0, December 31st, 2011
| Author: Nicolae Crefelean (kneekoo)
| Website: http://www.phpfusion.ro/
+--------------------------------------------------------+
| This program is released as free software under the
| Affero GPL license. You can redistribute it and/or
| modify it under the terms of this license which you
| can read by viewing the included agpl.txt or online
| at www.gnu.org/licenses/agpl.html. Removal of this
| copyright header is strictly prohibited without
| written permission from the original author(s).
+--------------------------------------------------------*/


FIREWORKS PANEL
---------------
This panel will automatically be enabled on January 1st, each year,
and it will stay active for 24 hours. The automation part is based
on the time settings of your PHP-Fusion installation.

Make sure you set the server time and the time offset correctly,
so the visitors and your users can make use of their time offset setting
in order to have this panel displayed exactly when it's supposed to.


INSTALLATION
------------
1. As a Super Administrator go to: Admin Panel -> System Admin -> Panels;
2. Click any of the options named "New Panel";
3. In the "Panel Name" text box write "Fireworks Panel";
4. From the "Panel Filename" drop-down menu choose "fireworks_panel";
5. Enter your Admin Password and choose a "Panel Side", then click the "Save Panel" button;
6. Click "Return to Panel Management", locate the panel in the list,
   position it and click "Enable".


SETTINGS
--------
There are two variables you can adjust in this panel:

$enable_on_user_new_year
$admin_preview

$enable_on_user_new_year
------------------------
Use the $enable_on_user_new_year variable to instruct the panel
to become visible either when your server's date reaches January 1st
OR the authenticated member's date reached January 1st.

Examples:

$enable_on_user_new_year = false;

The setting above is useful if you have a national site and you want to
enable the panel on January 1st for everyone, regardless the user time offset.

$enable_on_user_new_year = true;

The setting above is useful if you have an international site and
you would like the panel to become visible at the right time for every user,
based on their personal time offset setting. Of course, this requires the user
to be authenticated on your site, so the panel can use that specific time offset.

If you have $enable_on_user_new_year set to "true" but the user is not authenticated,
the time offset used by the panel will be the one set for guests.

$admin_preview
--------------
This variable is only meant for administrators to temporarily preview the panel
to see if everything is technically correct on their website
while the fireworks panel is displayed.

Examples:

$admin_preview = true;
----------------------
This will make the panel visible ONLY for a user authenticated with ADMIN rights.

$admin_preview = false;
-----------------------
This will disable the admin preview.


HAPPY NEW YEAR! :)
