head	1.6;
access;
symbols;
locks; strict;
comment	@% @;


1.6
date	92.12.14.07.44.48;	author lacey;	state Exp;
branches;
next	1.5;

1.5
date	92.12.14.06.16.55;	author lacey;	state Exp;
branches;
next	1.4;

1.4
date	92.12.14.03.33.26;	author lacey;	state Exp;
branches;
next	1.3;

1.3
date	92.12.14.03.11.51;	author lacey;	state Exp;
branches;
next	1.2;

1.2
date	92.12.14.00.25.47;	author lacey;	state Exp;
branches;
next	1.1;

1.1
date	92.12.14.00.03.09;	author lacey;	state Exp;
branches;
next	;


desc
@@


1.6
log
@*** empty log message ***
@
text
@\chapter{User Manual}
\label{user-man}
\input{intro}
\input{function}

\input{scenario}

\input{installation}

%
% You know the drill
%
\section{References}

For more information on the project planning tool that we are
presenting, refer to \cite{prj-desc}, \cite{prj-plan},
\cite{req-spec}, \cite{prelimin-design}, \cite{detailed-design} and
\cite{test-spec} in Appendix \ref{sec-ref}.  For more information on
PERT and Gantt charts, and critical path analysis in particular, see
\cite{cpa}.  The definitive reference for \LaTeX\ is
\cite{latex-manual}.  A good source for general information on XView
along with details of implementing XView programs is
\cite{xview-manual}.

\section{Project File Grammar}

The format of the project files for \xplan\ follows in BNF form.
Italicized items are non-terminals and bold text represents
terminals.  Following the BNF grammar is a sample file.

\par\noindent{\em project}\/ := {\em tasklist}\/ \\
{\em project}\/ := $\lambda$ \\

\noindent{\em tasklist}\/ := {\em taskblock}\/ \\

\noindent{\em taskblock}\/ := {\em taskblockhead taskblocktail}\/ \\

\noindent{\em taskblockhead}\/ := {\bf begin tasks} \\

\noindent{\em taskblocktail}\/ := {\em tasksublist}\/ {\bf end tasks} \\

\noindent{\em tasksublist}\/ := {\em atask}\/ {\em tasksublist}\/ \\
{\em tasksublist}\/ := {\em atask}\/ \\

\noindent{\em atask} := {\bf task = \{} {\em alist}\/ {\bf \}} \\

\noindent{\em alist} := {\em assignment}\/ {\bf ;} {\em alist} \\
{\em alist} := {\em assignment}\/ {\bf ;} \\

\noindent{\em assignment} := {\em stringassign} \\
{\em assignment} := {\em dependencylist} \\
{\em assignment} := {\em resourcelist} \\
{\em assignment} := {\em numberassign} \\
{\em assignment} := {\em booleanassign} \\
{\em assignment} := {\em taskblock} \\

\noindent{\em stringassign} := {\bf name = string} \\
{\em stringassign} := {\bf description = string} \\
{\em stringassign} := {\bf parent = string} \\

\noindent{\em dependencylist} := {\em dependhead dependencytail} \\

\noindent{\em dependhead} := {\bf begin dependencies} \\

\noindent{\em dependencytail} := {\em dependency}\/ {\bf end dependencies} \\
{\em dependencytail} := {\em dependency}\/ {\bf ,} {\em dependencytail} \\

\noindent{\em dependency} := {\bf string} \\

\noindent{\em resourcelist} := {\em resourcehead resourcetail} \\

\noindent{\em resourcehead} := {\bf begin resources} \\

\noindent{\em resourcetail} := {\em resource}\/ {\bf end resources} \\
{\em resourcetail} := {\em resource}\/ {\bf ,} {\em resourcetail} \\

\noindent{\em resource} := {\bf string} \\

\noindent{\em numberassign} := {\bf duration = unsigned} \\
{\em numberassign} := {\bf float = unsigned} \\
{\em numberassign} := {\bf plannedstart = unsigned} \\
{\em numberassign} := {\bf actualstart = unsigned} \\
{\em numberassign} := {\bf forecaststart = unsigned} \\
{\em numberassign} := {\bf earlieststart = unsigned} \\
{\em numberassign} := {\bf lateststart = unsigned} \\
{\em numberassign} := {\bf plannedend = unsigned} \\
{\em numberassign} := {\bf actualend = unsigned} \\
{\em numberassign} := {\bf forecastend = unsigned} \\
{\em numberassign} := {\bf earliestend = unsigned} \\
{\em numberassign} := {\bf latestend = unsigned} \\

\noindent{\em booleanassign} := {\bf milestone =} {\em boolean} \\
{\em booleanassign} := {\bf deliverable =} {\em boolean} \\

\noindent{\em boolean} := {\bf true}\\
{\em boolean} := {\bf false}\\

And now, a sample file:

\begin{verbatim}
begin tasks

task = {
	 name = "task 1";
         description = "This is a sample description...";
	 duration = 3;
	 planned_start = 2343;
	 planned_end = 92333;
	 float = 7;
	 milestone = false;
	 deliverable = false;
         begin resources
            "Mark M. Lacey",
            "Richard Malingkas"
         end resources;
}

task = {
	 name = "task 2";
	 description = "This is the description for task 2";
	 duration = 7;
	 float = 2;
	 milestone = true;
	 deliverable = false;
         begin dependencies
             "task 1"
         end dependencies;
         begin resources
             "Brian Gaubert",
             "Mike Marlow"
         end resources
}
\end{verbatim}
@


1.5
log
@*** empty log message ***
@
text
@d2 1
@


1.4
log
@*** empty log message ***
@
text
@d30 1
a30 1
\noindent{\em project}\/ := {\em tasklist}\/ \\
@


1.3
log
@*** empty log message ***
@
text
@a23 2
\appendix

d33 1
a33 1
{\em tasklist}\/ := {\em taskblock}\/ \\
d35 1
a35 1
{\em taskblock}\/ := {\em taskblockhead taskblocktail}\/ \\
d37 1
a37 1
{\em taskblockhead}\/ := {\bf begin tasks} \\
d39 1
a39 1
{\em taskblocktail}\/ := {\em tasksublist}\/ {\bf end tasks} \\
d41 1
a41 1
{\em tasksublist}\/ := {\em atask}\/ {\em tasksublist}\/ \\
d44 1
a44 1
{\em atask} := {\bf task = \{} {\em alist}\/ {\bf \}} \\
d46 1
a46 1
{\em alist} := {\em assignment}\/ {\bf ;} {\em alist} \\
d49 1
a49 1
{\em assignment} := {\em stringassign} \\
d56 1
a56 1
{\em stringassign} := {\bf name = string} \\
d60 1
a60 1
{\em dependencylist} := {\em dependhead dependencytail} \\
d62 1
a62 1
{\em dependhead} := {\bf begin dependencies} \\
d64 1
a64 1
{\em dependencytail} := {\em dependency}\/ {\bf end dependencies} \\
d67 1
a67 1
{\em dependency} := {\bf string} \\
d69 1
a69 1
{\em resourcelist} := {\em resourcehead resourcetail} \\
d71 1
a71 1
{\em resourcehead} := {\bf begin resources} \\
d73 1
a73 1
{\em resourcetail} := {\em resource}\/ {\bf end resources} \\
d76 1
a76 1
{\em resource} := {\bf string} \\
d78 1
a78 1
{\em numberassign} := {\bf duration = unsigned} \\
d91 1
a91 1
{\em booleanassign} := {\bf milestone =} {\em boolean} \\
d94 1
a94 1
{\em boolean} := {\bf true}\\
@


1.2
log
@*** empty log message ***
@
text
@d1 1
d34 1
d36 1
d38 1
d40 1
d42 1
d45 1
d47 1
d50 1
d57 1
d61 1
d63 1
d65 1
d68 1
d70 1
d72 1
d74 1
d77 1
d79 1
d92 1
d95 1
a134 12

%
% HINT!!!!:  Think about the worst user manual you've
% ever encountered.  Consider what you didn't like
% about it; was it missing something, was it redundant,
% was it incorrect?  After you've thought about these
% characteristics that you found undesirable, write
% the document with the intent of not emulating the
% worst manual you've ever seen.  ^^^  
%
% 
%
@


1.1
log
@Initial revision
@
text
@a114 8

\section{Bibliography}

\label{sec-ref}

\bibliographystyle{plain}
\bibliography{user-manual}

a125 3
\end{document}


@
