FileList.txt

From PHP-EMS-Tools

fileList.txt is included in the root directory of the PHP EMS Tools package. It is a list of all of the files in the package and what they do.

Version 3.0

PHP EMS Tools		http://www.php-ems-tools.com
--------------------------------------------------------------------------------------
Time-stamp: "2007-09-28 01:04:40 jantman"
#	$Id: fileList.txt,v 1.9 2007/09/28 05:06:03 jantman Exp $	
--------------------------------------------------------------------------------------

RELEASE PACKAGE FILE LIST

(anything called a "Form" is an HTML form generated using HTML_QuckForm class)
--------------------------------------------------------------------------------------
./
addBkEdit.php		Form to edit the organization address book
addBk.php		Page to display the organization address book
			     data stored in DB 'addBk' table
blankRigCheck.php	Page displays a blank rig check sheet to be printed
changelog.txt		Project's change log in a human-readable, descriptive format
Common.php		Part of the HTML_QuickForms class
countHours.php		Script to count up monthly hours for all members
custom.php		Left in for reverse-compatibility
			     just includes config/config.php
			     DEPRECATED
dailyMessage.php	Form to edit daily message shown on schedule
dispatchSchedule.php	Page that attempts to calculate how many members are on duty or needed at a given time (on a weekly basis)
doMassSignon.php	Handler script to update DB with data from massSignon.php
doRigCheck.php		Handler script to update DB with rig check data from rigCheck.php
emailList.php		Page that displays a list of all members' emails for easy cut-and-paste.
index.php		Main entry page with navigation links
install.php		PHP-based install script. Can be removed after installation.
INSTALL.txt		Installation instructions
LICENSE.txt		Copy of the License (GNU GPLv3)
localLinks.php		A script to include your own links on index.php
massSignOns.php		Form to allow a member to sign on for multiple shifts at once.
PEAR.php		Required file for PEAR / HTML_QuickForm
php_ems.css		Main CSS file for *all* of the project.
php-ems-tools.js	JavaScript file for all pages - popups
Quickform.php		Main HTML_Quickform include script
README.txt		Main README
rigCheckHandler.php	Allows user to select which rig to check. Links to the
			rigCheck and blankRigCheck with the appropriate URL variable.
rigCheck.php		Form for rig checks
robots.txt		Simple little file to make sure nothing's indexed by a
			search engine
rosterEdit.php		Form to enter/edit roster data
rosterCerts.php		Page to view certifications data
rosterCertsEdit.php	Form to edit/add certification data in roster
roster.php		Page to view the roster
rosterPosEdit.php	Form to edit positions and committees in roster
rosterPositions.php	Page to view positions and committees in roster
schedule.php		Main schedule page
signOn.php		Page (JS pop-up) to sign on to schedule
version.php		Script that contains the current program version. Used
			to notify user of new versions available.
version.txt		Text file to track which release you're using
viewRigCheck.php	Page to view details of a rig check
viewRigChecks.php	Page to view list of completed rig checks
--------------------------------------------------------------------------------------
admin/
.htaccess		Apache .htaccess file to control access for these scripts to administrators only. Please configure as per your site.
changes.php		Page to view recent changes to schedule.
checkCustomConfig.php	Script to check basic stuff in the config.php script
makeShownAs.php		Updates the shownAs roster field for anyone who
doesn't have it.
dumpTableSQL.php	Dumps the SQL code to initialize the tables

--------------------------------------------------------------------------------------
config/
config.php		Main configuration file. Used to be custom.php
rigCheckData.php	Data for the rig checks
rosterConfig.php	Roster configuration
scheduleConfig.php	Schedule configuration
--------------------------------------------------------------------------------------
docs/
--Documentation--
--------------------------------------------------------------------------------------
HTML/
	directory for HTML_QuickForm and Smarty
--------------------------------------------------------------------------------------
inc/		Includes directory
antman.php		Include file of some of the developer's common PHP functions
			     at the moment just turns a month number into name
global.php		A short set of global functions for use by other scripts.
notify.php		Script to notify members via email or SMS when someone
on their shift signs on, edits, or removes themselves.

--------------------------------------------------------------------------------------