README FOR THE XPLAN PROJECT MANAGEMENT TOOL (last updated Mars 9, 2000)
$Id: README,v 1.1.2.2 2000/03/09 23:23:30 xplan Exp $
(1) INTRODUCTION
XPlan is tool for project planning and scheduling. It is very similiar
in idea and concept to MS Project. However, XPlan does not look anything
like it. XPlan preceeds MS Project by dating back to a class in software
engineering given at Michigan State University in 1992. The original
authors were: Brian Gaubert, Mark M. Lacey, Richard Malingkas, and Mike
Marlow.
Since the original authors didn't have any plans to continue working on
XPlan, and there still is a need for a capable project planning tool for
X-Windows, xplan has been revived. The new maintainers have a couple of
really bold ideas:
i. Fix bugs in the v1.0 release and stablize it enough for
"professional" use.
ii. Try to port XPlan to the Gnome desktop.
Current maintainers are:
Joachim Nilsson, Daniel Rytterlund and
Mikael Bergqvist.
To come in contact with the developers consult the XPlan home page or
use the collective e-mail address below.
(2) REQUIREMENTS
XPlan was built using the XView toolkit and the SUN DevGuide interface
building tools in an all SUN environment. The currently available version
thus implies both the XView and DevGuide libraries to run. See the file
INSTALL in the xplan distribution for details.
(3) DEVELOPMENT
Development is done through CVS. Access to the CVS server is currently
limited to the developers. Hopefully anonymous access will soon be added
as well. If you would like to join in on the development please contact
the maintainers.
The following information is only usable to the maintainters. For a
better introduction to the CVS commands check out http://www.cyclic.com
(3.1) ENVIRONMENT VARIABLES
First of all you need to set some environment variables to be able to
access the CVS repository.
$ export CVSROOT=":ext:xplan AT cvs DOT vmlinux DOT org:/opt/src"
$ export CVS_RSH=ssh
(3.2) CHECKING OUT BUG-FIX VERSION
To work on the "bug-fix" version you need to specify the xplan-1-0 branch
when you check out the source from CVS.
$ cvs -z3 checkout -rxplan-1-0 xplan
(3.3) CHECKING OUT GNOME VERSION (not available yet)
The, soon to be, cool gnome development version is going to be located at
the HEAD branch, as is customary. To check it out you either start out
with an empty directory an simply type
$ cvs -z3 checkout xplan
since HEAD is the default branch. However, if you want to migrate to the
HEAD branch from, say, the xplan-1-0 branch you simply type
$ cd xplan/
$ cvs -z3 update -rHEAD -Pd
this will update the files differing in version and remove all stale
directories (Prune) and create all new directories.
(3.4) KEEPING UP WITH DEVELOPMENT
To keep your working copy in sync with the other developers you need to
update your files periodically. This is done by a simple
$ cd xplan/
$ cvs -z3 update -Pd
The '-Pd' simple prunes old stale directories and creates new ones to
ensure your copy doesn't contain any old files.
(4) LICENSE
XPlan is released under the GNU General Public License, GPL. The authors
state: "There is absolutely no plan for any of the authors, or anybody else
at Michigan State University or elsewhere to support xplan". The current
maintainers completely support this license. For further information on
the licensing issues consult the COPYING file.
---------------- Below is the original README file ----------------------
Hello and welcome to xplan version 1.0 (the final version, I wouldn't
doubt ;-). xplan was written as a semester long project in CPS 470,
Software Engineering, and Michigan State University, Fall Semester
1992. The authors were:
Brian Gaubert, Mark M. Lacey, Richard Malingkas, and Mike Marlow
There is absolutely no plan for any of the authors, or anybody else at
Michigan State University or elsewhere to support xplan. Use it at
your own risk.
We hope you find it useful, or are able to extend it in ways that make
it even more useful to you. The file INSTALL explains how to install
xplan on your system. The file COPYING explains the restrictions
placed on distributing and modifying xplan. READ IT BEFORE USE.
Below is a list of source files included in the distribution, along
with a list of known bugs.
Enjoy,
Mark M. Lacey
(and the rest of the authors)
SOURCE FILES INCLUDED IN DISTRIBUTION
PERT_Xstubs.c -- callbacks for PERT canvas
PERT_Xui.h -- initialization code for PERT canvas
calc.c -- checks dependencies
calc.h -- header file for calc.c
date-calc.c -- date calculations
db.c -- database functions
db.h -- prototypes and #defines for database functions
dependencies.G -- 'guide' file for dependencies window
dependencies.info -- help text for dependencies window
dependencies_stubs.c -- callbacks for dependencies window
dependencies_ui.c -- initialization code for dependencies window
dependencies_ui.h -- header file for dependencies window
export.G -- 'guide' file for export window
export.info -- help text for export window
export_stubs.c -- callbacks for export window
export_ui.c -- initialization code for export window
export_ui.h -- header file for export window
file.G -- 'guide' file for file window
file.info -- help text for file window
file_stubs.c -- callbacks for file window
file_ui.c -- initialization code for file window
file_ui.h -- header file for file window
gantt.c -- LaTeX generator for Gantt charts
gantt_Xstubs.c -- callbacks for Gantt window
gantt_Xui.c -- initialization code for Gantt window
gantt_Xui.h -- header file for Gantt window
guiutils.c -- utilities used by the GUI
julian.c -- date conversion routines
julian.h -- header file for date conversion routines
latpert.c -- LaTeX generator for PERT charts
latpert.h -- header file for PERT
main.G -- 'guide' file for main window
main.info -- help text for main window
main_stubs.c -- callbacks for main window
main_ui.c -- initialization code for main window
main_ui.h -- head file for main window
pagelist.c -- used in conjunction with LaTeX PERT generation
pagelist.h -- header file for pagelist.c
parser.y -- 'bison' production rules and action for
parsing input files
path.c -- used in finding critical path
pert-calc.c -- calculates the positions of PERT boxes for
both graphical display and LaTeX generation
resources.G -- 'guide' file for resources window
resources.info -- help text for resources window
resources_stubs.c -- callbacks for resources window
resources_ui.c -- initialization code for resources window
resources_ui.h -- header file for resources window
scanner.l -- 'flex' regular expressions and actions
semantic_stack.h -- definition of semantic stack for parsing
string_table.c -- string table used in database for resources
string_table.h -- header file for string table
taskinfo.G -- 'guide' file for task information window
taskinfo.info -- help text for task information window
taskinfo_stubs.c -- callbacks for task information window
taskinfo_ui.c -- initialization code for task information
window
taskinfo_ui.h -- header file for task information window
writefile.c -- code for writing files
xplan.c -- main source program
xplan.h -- header file for main program
KNOWN ERRORS/OMMISSIONS
There seems to be a problem deleting resources sometimes, and it is
most likely a problem with the code in db.c.
Exporting PERT charts to LaTeX was never completed due to time
constraints.