[phpws-comm-commits] modules/staffman/docs readme.txt,NONE,1.1

[<gbr...@pr...>]

Update of /cvsroot/phpwebsite-comm/modules/staffman/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18480/docs

Added Files:
	readme.txt 
Log Message:
Fixing readme.txt file

--- NEW FILE: readme.txt ---
-----------------------------------------------------------------------------------
phpWebSite Staff Listing README
-----------------------------------------------------------------------------------

@version $Id: readme.txt,v 1.1 2004/01/26 15:13:32 gbrackett Exp $
@author  George Brackett <gbr...@NO...>

-------------------------------
REQUIREMENTS:
-------------------------------
phpWebSite v0.9.2 - 0.9.3-2 and perhaps above

-------------------------------
FUNCTIONALITY
-------------------------------
This module displays and edits a single list of staff members in an
organization.  Each staff member listing includes a first and last name, position, 
contact information, notes (e.g., a short bio) and a photo.  All of these except the
last name are optional; if they are missing, the lack will not be evident to the user.
Anyone can view the list, sort it, and call up a detailed display for any member.
Administrators can add, edit, delete, view, hide and show staff listings, and can
create a menu item in any phpWS menu linking to the list display.  Everyone can search
through the listing for terms in the first name, last name, position, contact, or notes
fields.  In addition, listings provide category support which links to other items in
the same category.

------------------------------
INSTALLATION
------------------------------
This module is self-installing.  Simply drop the staffman directory into 
the mod/ directory of your site.  Log in to your site as Deity, select Control Panel,
Administration, and Boost.  The staffman module is listed as "Staff Listing."  Click the
install button. After successful installation, the module will appear along with other 
installed modules in the Content tab of the Control Panel display.

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

------------------------------
CUSTOMIZATION
------------------------------
To turn OFF the search function, comment out the section of /boost/install.php
that registers the module with the search module.  The beginning and end of the
section are indicated by comments in the file.  Then re-install the staffman module.

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

------------------------------
FOR DEVELOPERS
------------------------------
This module is based heavily on the first module I wrote for phpWS 9, jobman. I wrote 
this module for two reasons: (1) I needed to upgrade a similarly-purposed
module I wrote for phpWS 0.8.3, and (2) I wanted to understand even better the new 
framework and resources of phpWS 0.92+ worked.  

This module uses the wonderful functionality of the two core classes
for managing a list of items, PHPWS_Manager and PHPWS_Item.  If you intend to 
build on these classes yourself, and I recommend them, staffman is a simple place to
start from.  It only manages a single list of text items, about as basic as you
can get.  But having gone through it, I feel much more confident about using these 
classes to manage multiple lists of more complex data.  An example of the latter type
is the photoalbum module -- management of multiple albums containing lists of items
that include both uploaded graphics and text.  Indeed, I am indebted to the photoalbum 
module for many hints and examples.

I have also included other useful features in this module which may prove useful
to other developers.  First, I have included an interface to add a menu item to 
display the list, freeing administrators from having to know the operation value
required.  Second, I have used the help module to provide help for key items in
the interface.  Third, I have registered the module with the Search facility.
Finally, I have included category (fatcat) support.

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

George Brackett

------------------------------
VERSION HISTORY
------------------------------
1.3
	Extended compatibility from phpWS 0.9.2 to 0.9.3-2 and possibly above.
	Added update scripting to re-load the help file, which changed with this version.
	When uninstalling, staffman now removes any corresponding menu item or
	fatcat (category) entries.
	Added capability to view all staffmembers with a button on the main list
	page or by accessing the url
		index.php?module=staff&JOB_MAN_op=aView
	Automatically display the list of all staffmembers sorted alphabetically by 
	last name.
1.21
	Corrected several minor bugs -- error message on calling aView before a listing
	had been displayed, failure to remove fatcat items as promised.
	Automatically display the list of all staffmembers sorted alphabetically by 
	last name.
1.2
	Fixed missing help information in earlier upgrade (1.1 and 1.1.1) by adding update 
	scripting to re-load the help file.
1.1.1
	Corrected minor display problems when viewing multiple staff member listings.
1.1	
	Added capability to view all staffmembers with a button on the main list
	page or by accessing the url
		index.php?module=staffman&STAFF_MAN_op=aView
	When uninstalling, staffman now removes any corresponding menu item or
	fatcat (category) entries.