/***********************************************************************
  Content (Enhanced) for Dragonfly(TM) CMS
  **********************************************************************
  Copyright (C) 2005-2007 by Dark Grue

  Homepage: http://www.theclenchedfist.com/projects/content/

  $Source: INSTALL.txt $
  $Revision: 9.7.11 $
  $Author: darkgrue (darkgrue @ iname.com) $
  $Date: 2007-10-31 $

  Based on:
    The Content Module Enhancements by BrokenCrust.

    Content Module 2.0.1.0
    Copyright (C) 2004-2005 by CPG-Nuke Dev Team
    http://www.dragonflycms.org

  License:
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or (at
  your option) any later version.

  This program is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  02111-1307 USA
***********************************************************************/


**************************** Module Install ****************************
This module is easy to install with no hassle from SQL files. It uses
Dragonfly's module management system to make it easier for everyone.

To install, just upload the content of this zip to your "root" directory
so that the dirctories line up, like for like:

	blocks   => blocks
	language => language
	modules  => modules
	etc.

You may be warned: "Do you want to overwrite the folders?"... just say
yes; these won't replace or remove the wrong files.

Login as admin and go to the "Modules Administration" page, which will
autodetect the new module and check the cpg_inst.php file.

The cpg_inst.php file runs the necessary SQL commands to setup the tables
and make the appropriate changes to the database (select "Install").

When you see the module in the list of modules, everything is setup and
you can begin to use it.

That's all!


NOTE: Be mindful that (multiple) settings in php.ini can significantly
limit the size of posted pages. Check your post_max_size and
memory_limit values (from admin.php?op=info&core). They should be set
pretty high (the default is 8M). These values will also limit how much
you can upload (Coppermine and Downloads modules most notably). Chances
are, you're running with the defaults, and normally, that's enough.

Check out the values of hphp.post.max_value_length and
hphp.request.max_value_length (from admin.php?op=info&mods). If you are
running Hardened PHP, those variables will exist, and the defaults are
65000. Increase those settings (setting them to 8M to match the defaults
for post_max_size and memory_limit isn't a bad choice) in your php.ini
file. Note that you may need to restart your webserver in order to force
running processes to reread php.ini to get the new values.


************************* Module Instantiation *************************
Multiple instances of this module can be created by making a copy of the
module directory and adding an underscore followed by an integer to the
name of the directory (e.g. "Content_2"). The module will detect
this and automagically configure itself.

NOTE:
  * The module will check $mod_basename against its installation
    directory.
  * Blocks that reference this module MUST be configured separately to
    reference the new instance (e.g. naming to
    "block-Content_Menu_2.php").
    
The naming of the module installation directory and block filenames are
set to follow a pattern. Both blocks and modules check against a
hardcoded base name and then look for an instantiation extension; the
module will NOT function if it does not pass that sanity check. The
correct naming convention is the base module installation directory
followed by an underscore and a number. Blocks follow the same pattern.
 
The module name may be changed from the default name of the installation
directory by going into the Module Administration Panel, selecting the
"Edit" option, and entering the desired title in the "Custom Title"
field, then pressing "Save Changes". Users using multiple instances will
almost certainly want to do this, to avoid unhelpful titles such as
"Content", "Content 2", "Content 3", etc... Blocks can be similiarly
renamed from the Block Administration panel, selecting "Edit", and
entering the desired block title in the "Title" field, then pressing
"Save Changes".

NOTE: Don't rename the module's installation directory after you have
installed the module - neither the module nor the installer will be able
to find the module's tables, and you will be unable to uninstall the
module until it is renamed back to the original name the module was
installed under.


********************** Upgrading to A New Version **********************
The cpg_inst.php file runs the necessary SQL commands to setup the
tables and make the appropriate changes to the database.

When you upgrade a module, go into "Administration Menu > > Modules
Administration" in the Dragonfly admin panel, scroll down to the name of
the module, select "Edit" and press the "Upgrade to x" link on the
"Version" line. The installer should (ideally) return with success, and
you're good to go on the next version.

NOTE: If you have used a previous version of the Content module, be
sure to remove the [rootdir]/modules/Content/language/lang-english.php
file before installing this module or you will experience missing
language elements when the page is displayed (things like _TRANSCATEGORY
or _MAINPAGE being displayed in place of text).


************************* Uninstalling Content *************************
When you upgrade a module, go into "Administration Menu > > Modules
Administration" in the Dragonfly admin panel, scroll down to the name of
the module, and select "Uninstall". You may then delete the module
directory and blocks.