-----------------------------------------------------------------------------------
phpWebSite Uplink README
-----------------------------------------------------------------------------------

@version $Id: README.txt,v 1.4 2004/12/27 16:00:56 gbrackett Exp $
@author  George Brackett <gbrackett@NOSPAM.luceatlux.com>

-------------------------------
COMPATIBILITY:
-------------------------------
phpWebSite v0.9.2 - 0.9.3-3, 0.10.0

-------------------------------
FUNCTIONALITY
-------------------------------
This administration-only module (it has no public interface) augments the Documents
module by allowing the quick upload of files that do not need to the more complex
data structure and interface provided by Documents.  Specifically, Uplink
	*	uploads individual files of many types
	*	provides explicit local and full URLs to each file for easy copy and paste
		to a link in a web page, announcement, block, etc.
	*	optionally re-sizes image files of type .jpg, .png and .gif to fit within
		a rectangle of configurable size (default 300 x 300 pixels).
I wrote this module to support teachers who want an easy way to upload a picture,
PDF or HTML file and then provide a link to display or download it on a course
web page.

------------------------------
INSTALLATION
------------------------------
This module is self-installing.  Simply drop the uplink directory into 
the mod/ directory of your site.  Log in to your site as Deity, select Control Panel,
Administration, and Boost.  The uplink module is listed as "Uplink Module."  Click the
install button. After successful installation, the module will appear (for users with
access rights) in the Administration tab of the Control Panel display.

------------------------------
CONFIGURATION
------------------------------
The file mod/uplink/conf/config.php allows modification of
	*	UPLNK_FILE_TYPES: a list of file types uplink will upload
	*	UPLINK_IMAGE_MAX_WIDTH, UPLINK_IMAGE_MAX_HEIGHT: the dimensions in pixels
		of the rectangle uploaded images can be resized to fit inside.
If you change the UPLINK_FILE_DIR define to some other directory than files/uplink/, 
make sure to create the other directory and give the server write access to it.  The
maximum size of uploaded files is the value in the php.ini file, which defaults to
2 megabytes.

------------------------------
UPDATING
------------------------------
This module is self-updating.  Simply drop the uplink directory into 
the mod/ directory of your site, replacing the existing uplink directory.  Log in to 
your site as Deity, select Control Panel, Administration, and Boost.  Click the Update
button next to Uplink Module to complete the update.

------------------------------
UN-INSTALLATION
------------------------------
To uninstall this module, log in to your site as Deity, select Control Panel/Administration 
and then Boost.  Locate 'Uplink Module' in the list of modules, and click
Uninstall.  NOTE THAT UN-INSTALLATION DESTROYS DATA in the form of information stored in 
the database and files stored in files/uplink/.

------------------------------
FOR DEVELOPERS
------------------------------
This module was written quite quickly by modifiying the skeleton module provided with
phpWS version 0.9.3-3.  I recommend this approach for developing any module that needs
to manage a list of items with an interface that conforms to others throughout phpWS.

I hope you will find uplink a useful example.  If you find errors, or wish to 
suggest improvements, please contact me directly.

George Brackett

------------------------------
VERSION HISTORY
------------------------------
0.7.4
	Replaced control panel icon with .png file.
	Used PHP function version_compare() in install, update, and class code to
	be compatible with new versioning system.  Module compatible with phpWS
	version 0.10.0.
0.7.3	
	Access rights now tested correctly.
	Module now catches and disallows upload of a duplicate file.
0.7.2
	Module lacks only proper access rights code.
