-
SPECIFICATIONS AND USER~S MANUAL
FOR A REPORT WRITER PROGRAM
SUBMITTED BY: Cindy Jackson
-
SUBt1 I TTED TO:
CLASS:
QUARTER:
DATE:
Glen f1apes
ID 499
Second Summer Session,
August 13, 1984
1984
0.
f,',
LU
TAB LEO FeD N TEN T S
~/'.i1;3?
, ~~ J.4
-
: ,',i::"'f
t,
,
SFECIFICATIONS
.;;r~13
Introduction
---------------------------------2
System Configuration
Software Functions
Accuracy
--------------------------------------
Error Handl ing
Functions
---------------------------5
-----.---------------------------
6
-------------------------------------
7
Definition of Terms
---------------------------
8
--------------------------
9
----------------------------------
19
Hierarchical Diagram
Cell Diagram
-
..
·1 •
INTHODUCTION
-
Often a file contains data that many users need to access.
Usually a
single report is developed for all the users that may contain some
unneccesary data for their needs.
Or perhaps a separate report will be
created for each individual user, at a high cost, to meet their
specifications.
This system is bein9 designed to solve th?se'problems.
It allows the user to design his own individualized template for a-report
he may use repeatedly.
A system for the input of data will be developed using these
specifications.
The data will be either headings, formulas, or other
numeric data and will be input from the keyboard or extracted ~rom a
file.
Two separate modules will be created for this purpose.
The first
will be a template generator type program and the second will be a report
generator type program.
Using the template generator, the user will
design a report for his ongoing use.
The 'template generator allows for the formatting and development of the
final product - the finished report.
Using this facility, the user will
have the ability to enter headings of his choice, data that is relevant to
his needs, and format the report to his desired specifications.
The dtita
may come from a file or data base or may be input from the keyboard.
Once
the template generator is complete it will be saved to be used over and
over again.
The report generator will create reports using the template created
previously by the user.
It will access the file or data base each time it
is invoked, to assure timelines~ of data.
All formulas will be
recalculated using the current data.
Other options will include the ability to sort data on one or more user
specified fields, perform searches for particular ranges on fields
specified by the user, and print the report to obtain a hard copy.
".
SYSTEM CONFIGURATION
This system will be adaptable for use with any 16 bit computer using a.
multitasking operating system.
It will be written in a modular fashion
utilyzing a high level language which will allow for future changes~
~
:, ~
A typical system configuration might pe a 16 bit personal computer, with
128K bytes of RAM, two 320K-byte floppy disk drives, a monochrome monitor,
a standard keyboard, and a draft-quality printer.
•
,-
>
';'
SOFTWARE FUNCTIONS
-
1 -
TEMPLATE GENERATOR
1.1
The template generator will display user friendly prompts and ~enus to
enable an ine~<perienced user to creat~e the template for the.. ~-epor-t.
These
menus and prompts will guide the user through every step of the template
generator creation.
They will enable the user to place headings where
desired, adjust column widths, input data, save previous entr-ies, correct
errors, and find more help when needed.
1.2
The software ~ill provide a SAVE function to save a copy of the finished
template.
This will allow changes to be made to the template wnlle
allowing the present template to remain in use.
1.3
The software will provide clear error handling.
The messages will not
contain technical jargon and will act as prompts for- error corr-ection.
An
example of easy error handling is the ability to clear a cellar the
ability to type over an unprotected cell in the event of erroneous entry
of data.
1.5
The software will provide a help screen in case the prompts alone are
insufficient to get the user through the cr-eation of the template.
It
will be detailed explanations, in layman's terms, of the commands and
functions available to the user.
1.6
The software will provide certain set defaults.
1.7
The software will provide a means for specifying the column width.
the means for insertion of columns and rows.
Also;
1.8
The software will provide a means for scrolling up, down, and sideways
since the template will undoubtably be larger than the screen.
.
REPORT GENERATOR
2
..
2.1
The report generator will supply user friendly prompts and menus to enabie
the user to perform searches, sorts, and the print function.
2.2
The software will allow the user to sort on a user specified field cr
fields.
He will have the option of ascending or descending key for th~
sort.
He may opt to sort on an ascending key for the prim3ry ~ort field
and nn a descending key for the secondary sort field~ ~t~ .
....
£
..,..
• .J
The soft ...Jare "lill provide the user \">lith thE' ",bility to p'?rconr 'Ot"oTchc:::=
The log i cal operators AND, OR, and r,fOT wi 1 I h~-' 2'.-'.:e.i 1 ,,:t:J 1 '=.?
n thE !Y'=T _~
well as the relational operators <~ >, =
2.n,~
rhi"", ~"J.iJ 1 all.m"
the user to extract only data which is per.inent to hi'~ ~D ~~ di~~12~c_
!
',"
'4 •
-
2.4
The software will provide a means for printing a hard copy of the report.
2.5
The software will provide clear error messages for the report generator.
If the user enters an invalid sort command or an invalid search command.
he wi 11 be prompted on hm-J to conti nU,e in order to correct .th,e~ error.
.
2.6
The software will be capable of being scheduled to be executed at a given
time (i.e. daily, weekly, by shift).
2.7
The software ~ill provide a separate help screen for the report
generator.
It will explain the various search functions, sort functions,
print functions, and error messages in greater detail than possible with,
prompts.
2.8
The software will provide a means to scroll up, down, and sideways since
the report will undoubtably be larger than the screen.
",
"~
o
.
ACCURACY
-
.
Accuracy will depend on the accuracy of the data contained in the file 6r
.. ~
-.....
The user deflnes
declmal
locatlon.
data base and on the user"s lnput.
Also the user has the option of right or left-justifying the data by
field.
The software will contain a check for corruption of the template file.
The report data will use the most current file data each time the report
is used.
In other words, when the program is invoked, the most current
data from the file will replace any outdated data that was in the report
previously.
NOTE:
kept current.
be the user's responsibility to see that the input file is
That is outside the realm of this program.
-
".
',"
6
ERROR HANDLING
.-
.
Errors input by the user ~'Jhen creati ng the tempI ate ~·Ji 11 be easi 1 y
corrected by typing over them.
If an unrecognizable command is entered,
an appropriate error message will be sent to the screen.
The user will be
able to protect fields he is sure are entered correctly, at any time, thus
eliminating possible errors caused by, accidentally typing Gyer- a cor-t-ect
field.
A completed template should be copied and saved in case of damage to the
first.
This will also provide a copy to make future changes to without
destroying the original.
&
-
';.
FUNCTIONS
~
The program will provide the basic mathematical functions for addition,'
+- ,i"
1 t·lp I lca
t lon,
.
..
su b +-~rac_lon,
~lvlslon,
mu~
exponen~laLlon,
square rsoc, anar
percent.
There will be simple keywords for the basic operations as well
as the usual operational signs for use in complex formulas.
.L.
-
•
-.
In addition to these arithmetic functions, there will be two
data-management commands.
These will be the sort command and the search
command. The user will be able to sort on one or two fields, in ascending
or descending order.
He will be able to perform complex searches
involving one or more criterion.
There will be commands to allow the user to format the data, insert and
delete columns and rows, adjust the column width, align the data, protect
or unprotect ranges, retrieve data from a file, and print the report.
These commands will be in the form of nested menus.
-
...
DEFINITION OF TERMS
A glossary of terms, a summary of operating instructions, and a sample
session will be included in the user manual.
.,
~
,.-~'
o o c c
••_.--,."
o
.-.• , _
......... -_...
.
~.,"-
...... -- .....-
._" .. -.
-"~".''''P-
~
.....
~,~,_.---..
o
-
.,____ .J
,.,
_.._
)
)(
::: "1
~
1
1
-I
I
I
1
1
Z
":J
r'
....
~I
~I
'J 1
'-:"'1_1
., I I11
?
""I
':I
"il...,
on
-I
!1
i'"
"I
I
I
I
',?
1
i
1
I
-I
;=
..,
1 I
!1
"
I
1
1
1
1 1
Z >1 1
~I 1
II '..
;v»
., :J
-I
<
,I
1
1
1
1
-II
;0
~
:;1
Z
on
"I
'" ;1
:"II
":JI
I
1
1
I
:->
~I
.." .on 1
Z 3:1
11 ." 1
"r--I
_... ;:. I
1 .., -< 1
1
1 :J .., 1
I
1
1
I
"
1
1
1
1
1
1
I
1
1
1
.j;1
51
"'I
1
1
1
1
II
I
1
I
>-1
1
-1
1
1
1
1
I
21 1I
Z
0
1
L.-I
I
1
~I
Z
":J
1
I
I
-I
"" '1
0
m
':)1
.., >1
:"I
c
I
-I
1
1
, 1
~--'
~I
1
-I
1
..,-1
-I
!
~I
I
VlI
I
1
1
1
1
1
"'Z
m
;<
-1
1 :001
1 :n >1
.... "'1
" >1-.-1
1
1 1
1 <
1 1
1 '>
-I
I
"C
»
:->
m
1
I
1
-I
1
1
.,
I
I
I
~:->I 1
rn m
-0 Z 1
'=·'1'11 I
-----
-I
I1
1
-'
1
I
-
I
I
1
1
1
I
1
:;i
,
1
1
;;. .c
=~I
;tl
I1
1
.;;:} :J I I
- "-I
z
:->
1
1
, I
: : ~I-'
z
1
~-l
1
1
1
1
;;.
I
1
I
:J ,""I
I
I
~ .."
I
=0-1
,- 21 II
1
1
1
VI
1
""::1
'" -1,
i:'1
1
1
1
., ;>-1
I
:l!:; " 1
::> 11 1
- .,1
.... :::1
,
1,
,-
I
I
~;::I
m ,111
Zn::J
'0
II
1
I 11
":; ...."--I
,
0
:0
I
'.
..
-l"' .
'-
)()
("'I
("
____ 1__ _
lTEMPLATE 1
IGENERATnRI
1_____ 1
f!\
~
fill
('I
e
f\
('
I
-----------------------------------------------___ --__ 1--_____-----_______________________________________ _
____ ,____
---_1____ ,___
___ 1___
___1____
__'-___
'r~rnr
I
I H<'INDL HI" I
ISrI
1
I nrpULTS I
InATi\
I
I nJTPY'
1__________ ,
L ________ I
1
1
1
___ 1___----------------_
IHFLfl
1
'F.\r. III TV I
1________ 1
1
IOATA COR-I
I RFCTNFSS 1
1
'-_____ 1
1
---'
I
,
----------------____ ,____
--__ 1__ -- ____ 1___ _
I :."r( IrIrnll f)rTflTtFD II srHTr-TFnl
'WLP KI=V llEXPLM1AT.llrSr.. K;:Y 1
I ________ 1 1_______ 1 1_____ 1
C"
__ --__--1 _ _ _ _____ , ________ 1--- __ 1__ _
e
IF.Xr'UIN
IIEXPLAIN
IIEXPLAIN
1
1niNO TO~ SII r:RP OR CfW II cnMMANDS 1
, _________ , 1______ 11 ______ 1
ICOMMANDS I
I
1
1_____ 1
I
IFU'l(T((I~j<)1
I
I
1________ 1
,
-=--1=---------------------------------==1____
ITYPF ovrRI
lFE:HURF
I
IMFSS/\GFS I
1
I
1
I
I
- - - - -_ _ _ _ _ --1
_ ___ ,___
__1_-
I rr LF NOT I I INVALID
IFOUND
IIArynRFSS
__ 1_____ ,__
-
"Ri\NGE
II
, _____ "
_ __ I _
II PROTFCHOIIINVi\l rn
IIINVALIf)
IICElL
IISORT KEY IIFORMULA
1_____ 11
11 _ _ _ 11
_ _ 1_ ____ 1_ _ _ _ 1 _
lCELl
I
1_______ 1
I
I
I
I
11 _ _ _ _ 1
___ '-_ _
__1 _ _ _ 1__ _
IDIVISION II INVALID
1
I BY ZERO
II OPERHOPS I
1_______ 11
I
e
~
e
C>
e
•
.
•
o
o
(
(
--- ...
...
o 0
o
o o
e
•
e
oJ
)
?
" '::JI
:"11
-I
0''11
-
1
3:-1
"'I
r-
II
1
1
1 1
1 1
-I
1
1
-
~I
:::";1
Z --I
~ ':ll
,--0-
I
1
I
Z
I
I
1
I1
1
·71
1
1
1
I
1
1
!1
I
I
~"'I
1
;-;1 II I
"TI -q
1
I
1
1 1 1I
,--I .... /I
1
I
I
II
;>
I '"
1 I
1
1
I
1
I
1
1
1
1
II
1
1
I
i
I1
I
1
1
1
1
1
-'I
~~I'
;a>
........
-<
III
1
-
I '-=-7J I
'~~I
~""I
1
1
-I
I
I I
1
I
r-j1
1
1
1
1 m-001
>1
"-i 1 11
1
-I Z
-I
1
1
--- I
1
I
I
I "'~I
1
1
7: ;""\
1
1
1
I
-.:lr
:::ll 1
I -i=
I
ZA:-I
I
I zl
~
I
1
I
I
1
I
I
81 1
A:I 11
>-1
1
51
I
VlI I
I
1 I
--- I
1
1
1
I
3:
1
1
I
1
1
I
I
1
I
1
1
1
1
-0
I
I
1
1
1
1
1
I
1
........ 1
:::lm
1
1
1
1
1
1
>1
" r:>
.... l>
1 CTI<"'l1
:/l:::ll
1
I
I
0 .... 1
"TI ' " 1
Z 3: 1
." ~I
I
I
""I 1
1
21
:"II I
-i - I
-I
~I
'1
0,
.,
------------.~-.-----. - " - - ' -
o
0
e
• •
e
- - . - , - - - . - - -.... - -... ,.-.. -.-'--.~.... ---..... ---.-~.... - -..... -----.-~~-~ .. - ... -.-.~....... j
'.,
• •
'J "
, 3:,
, 21"'
I
1
-
1
I
=1
-I
I
I
I
1
I
1
I
I
I
I
I
I
-I
::." I
;:'"'JI
'::"'J I
:::l::ll
:-"-1
I
-
1
I
;;'l
1
I
I
I
I
II
'I
I
I
II
II
II
I
II
I
I
I
':J'Jl\
'11-i
"<711
-I
>
I 1
I-I
~
I ~ I!
1
I
I
iI
I
2111
r-
~-I
~II
.."
I
1
I1
,
I-~~Il
I
'
1
1
1--' ~~ II
-
I
I
1
I
1
I---~I
II
~I
::0-1
nil
-----("II I
1
-i 01
I
1
1
f
~~II
m> I
'XII I
>--::::1
~~I
-i >1
i
I
0 I
<.11:0
~I
1
~II
"
I
I
I
!
,
--~I
I II
:1:1
1-'--1
I
,
5', I
'"
::;-1
..... ,
!I:::JI
21
I
I
I
m ";)1
:>:J
r--
»1
-i ....
1
1I ~""I
I
I
1 I 1
1
I
1
i
I
J ~LI,
~i
'
1
'
!
I1
Cl -i
m."
Z 3:
I1
I1 I
31
I
1
~~II
VI
II, I
;':ll
I
I
I
?;l01
-I
I
m
L-_
I1
1
1
I
I
::t
:.
I
II
-I1
1
I
1
".
I
1
,
I
I
I
I 2,' I
I
-I
I
1
L
1
~'-I
_I
::::II
2
"_"
"
o
---_._
0
o
-
.. --~---- .. ... , .. ~--'.'
o o o o
.-~----
......
.,
- .--....-- -
o
\
21
~I
-
:;:1
""1
""',-1
.... 1 1
"I
1
..: ,n 1
". ' I
:::::::>1
.:l;:)1
r- 0-1
1
I
I, ..,z I1 I1
1
1 I
I
1
I
I
I
1
1
I
___ 1
I I
_
1
I
I
1
II
I
I
1
1
I
1
1,
I
:j
~
II
-
1
~;;;III
..,-1
1
.....
-t
,
I- I1,
I
VI
1 I
!I
:..
c:
,1
C:-I
r-r :
1
>1 I
1
I1
1
I
I1
1
sg ~I
-
I
I
I" I
;;:~I
I -<
I.
~--
-
I
I
1
,1 ~~I II I
1
~--I1
1
"-11
-t
11
-I
,.",,1 I
;:)1
Z
I I ""
:.tl
I
~
~
"
I
I1
I
1
1
I
1
O~
;0 ..,
II
--- I
I
I,
I
~~II1
OZ
1
1
m:-n-I
~
1
-I
81
~I
I
I
l»-
~II
I
"', I
I --- I
I
I
I
I1
II
I
I
I
I
,
1
I
-
I
~-I
~;I
I ~ ~I
1
I
1
1
I
,
1
I
!
-I
1
.."
1
-= 1 I
~L-I
-I
~I
0.
..
,'.
,
1
!".
C"
1 r,
("\
C"
__ 1_-
(\
lTEMPLATE J'
IGENERATORI
' ___ I
1
Co
~
t'
~
c
(\
(
..
(l
•
____ ------------------------------------,1___
__L_
__'-_
IFP.Pf'l::'
1
II~IINDLH!G
1
ISFT
I
lOATA
IDq:i\ULTS I
1_________ 1
1
IENTRY
1_____ 1
1
__ 1___ _
I
--,--
I
IDi\T/I r.nR-I
I
'RECTNESS ,
1
- - = r = - - _ - - - - - = - - I ___ _
I
Ifll~l(Twrlsl
ICOMMANDS
,
I
1_____ 1
,
I
1_____ '
1
__ 1_-
__ 1__
1
I
1_ _ _ _ '
1
,------------_ __ 1__ _
ITEMPLATE 1
ISAVE
1
IRANG[
I
1
I
1
1
1
1
1_ _ _ 1
1
1
L _____ I
I
1
___________ ___________________ 1___
1______ _
___ 1___ - ____ , _ _ _ _ , _ _ _ _ , _____ 1_ _ _ _ 1_ _ _ _ 1_ _ _ 1_ _ _ _ 1_ _ _ _ 1_ _ _ 1_ _ _ _ 1___ _
Ir,LnnAL
IlcrlLU"IN
IlrR{JTFCT
IIINSFRT
IIDElETE
IIFIXED
IISCIENTIlpERCENT
II LEFTIICENTERED IIPROTECT
IINA"'F
1
1
II WIDTH
II0NIOFF"
"
II
"IFIC"
II ALIGN
"
1I0N/OFF
II
1
1_________ 11 _______ 11 _____ 11 _ _ _ _ 11
11 _ _ _ _ 11 _____ 11
"
"
" _ _ _ _ ' 1____ 1
1_____ 1
, _ _ __
___ ,__ _ __ ,_.__ ___ , _ _ _ _ 1_- ___ 1__ __1 __
IFIXFf)
IISCIENTII COLUMN
II ROW
"COLUMN
tlROW
I
1, _______ 11
II
l
F
t
C
"
II
II
"
_____ 1 , ______ 11 _ _ _ _ 11 _ _ _ 11
I,
IEFHTEVc 1
1FlU
1
, ______ 1
~
8
"
5
.
•
•
•
o
o
(
(
(
,- ---. -
~
.
."
Ie
I1
lit
!fIII
I
J~
Ie
__ I _ -
I TFMPLATE 1
~
-----,----
,rr-ROP
,
IllANOL P:G I
.f)
j
,--------,
I
!~
,-----
t
je
le
Ie
J ADOY T YON-'
I
I
J _________ ,
___ 1__I SET
I
IfJtFAUU:; I
1_____ 1
I
__ I _ -
I SURTP I\C- I
ITTrN
I
L __I
__ L _
1DATA
I
IENTPV
I
1_ _ _ _ 1
I GEnERATOR_'
I
I
I
1_ _-
_ _ 1__ IDI\TII CDR-I
IRf'r.TNESS I
1_____ '
1_ _ _ _ 1
I FllNCTJI"J';'
1I_____ 11
I
I
I
I
__ 1__ I AV ERAGF I
I_ _ _ _ 11
1
---=,--
_1-
IcnMMMln<; I
I
I
lOIVISION ,
I
------------------------_----___
----1
__ 1___ 1__
_
__ , ___ _
IMULTJPLJ-I
I Fxrnr--sPIT-1
IS'JIIARF
I
I
ICATION
_1-
,____ ,
1
I
L ____ I
ITI lITTON
I
' _____ 1
InOOT
1
1_____ 1
je
•
JO
I
,0
0
0
0
0
0
0
0
0
0
(
(
(
'- .
1
--
-
."
0-
1 c,
("'I
__ I _ I RFPOIl T
I
I GEN FRA TnR I
'-_ _ _ I
I
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -______ 1______- - - - - ___ ,___
__1___ I __
("
("\
(\
I fill TA
e
~
e
I
IP:-T~IEV,\ll
1_____ '
I
I
__ 1_______
____ ,__
_ __ 1____
1r
1'- f'1.,\ I~ F I
I F l a j1-
(\
ICOMMANOS
I
"
"
I
I
__ I ______ _
__ I ___ _
I
I
I. INAME
I
1________ 1 1______ I
e
Ir..Uf.IJLt\ TF I
IFORMIJLIIS I
__I_-
I PERFORM
, P rT R J EVE I
I DATA
I
1_ _ _ _ '
I
___1=--=-----------:::__ 1____
Ir.ENERJlTE I
IERI/nll
1
IREPORT
IH~NDLJN~
I
I
__ 1_I
ICONVERT
,
IOPER.t\TIONS
I
I
_ _ 1_ _ __ 1_- __ I __
I FUNCTIONS II PRECEI
ISEE ASOVEIIOENCE
,
I
c-.
I
I DATA
I
I
,
I
I
I
,
1_____ 1
___ 1__ I RFTIJRN
I
I RF SilL TS I
1______ 1
" _____ 1
_ 1 __-
1______ - - - - -
_ 1 _ _ _ _ 1___
___ 1 _
IEXPONENT-IINEGATION "MUlT &
IIAOO &
,
IIATTON-->II --->
!lOIV --) IISIJB
1
I
II
11 _____ 11 _ _ _ _ 1
~
e
•
•
Q
e
•
•
•
o
o
(
,
(
..
e'
If,
e
t'
__ ___ _
~
I REPORT
1
IGEN~RATOR 1
'-____ 1
~
e
1
.
______________
' - - - - - - - - - - - - - -______ 1______ ---------------------------_____ _
____ ,___
__,___
IO~TA'
'CALCULATE!
1R['TP 1 !.:vlILI
IrnPMI)LAS
,--______ 1
1
I
__ 1__
1
I
'-____ 1
IGENERATE
IREPORT
1
__1 __ _
1
1
II'=RROR
1
IHA~mLIN['
1
,
15f"ARCH
I
_ 1 __ ISORT
I
1
I
I
I
'-_ _ I
__ 1_-
,-----,
1
______ 1_ _ _ __
___ 1_- ___ 1_ _ _ _ 1__
IPPYMAq~
IISFCONDARYIISTART
1
IKEY
IIKEY
II
I
1_______ 11 _____ ' ,
1
_____ 1'-______
____ , __ ___ 1_- __ 1_ _ _ _ 1__
IASrFNnJNGI lorscENo- '1I\S(FN~lNGlloESC[NO- I
I
I lING
II
1, YNG
I
, ________ 1, ____ , 1__
"
1
_ __ I1
__1 _ _ _ 1__
IRElATION-IILOr.YCAL
!
fAL OPRlS I!OPERATORS!
1
11 _ _ _ _ 1
1
1
_ ! _ _ _I -
I>, <, =, III\NO, OR, 1
1>=,<=,<> IINOl
1
I
"
I
(1
;0
e
•
o
o
o
o
o
o
(
1
1______ 1
I
1_ _ _____ 1
e
e
1
1_____ 1
~
•
•
•
_ __ 1_-
ICOMMANDS
~
00
•
•
e
• • • •
--_..
-.--.-----~----- --~-~----
-
,
I
I
-I
I
-U'~
iT1
,.,'
I
>1
-to4l
;0"'1
....
-I
m
::0
I ,
rI ,
,< I ,'
I---
,,
,I
onl
>0
04 zi
l><
I
m-
I
I
~I
I
I
·1
-
I
""-'1
I
I
~;I JI
C_r- - I
> ""
m
V> -t
I
I
I
1
1
,1
I,
1
I
i
.-
~I
I
I
1
~~I
II
~~I
I
1.--- I
I
I
'!II --I ~~"I
.z
-Ii
I,
,,
I
-
I
1
I
:::"'1
~ ~I
;;;i;:)1
II
,
r-;O-I
-~
1I
~)
I
.
'
_..------------------o o o o o o
o
.-------------~~-.~.
o
_.._.._-,..._--"--_........ -
• • •
o
....
.--~-....---~'-----------
•
I =l'" ::II
~I
-',
;OJ>
-I
.."
I
1
II I
<
,...'>
I
I
I
I
1
1
:,'
II
I
I
I
!
t
I
1
I
I
II
JI
"'"'.-' '1 I
OJ>
3:
I
("'I
C:::=-I
r '-1 I
;:. ~I
I.,..., ..-..41
I
'" I
I
I
-
'"'I
~I
I
~II--
--- I
COl
::::ll
.",,,
z.",1
"'01
;0;;:)1> -d
~
,
I
I
I
I
I1
I
;0 COli'
m."
:; !/-I
;5
~
-I
m
I
I
I
I
I
I
I
I
,I
:;;~I
"'""J
I
I
I
I
..;:).,,>- I
II-:;ZIII
"",. .
n ,n
"''01
I
~nl I
I
I l>t _"I
I 0z ""
1
;:)1
nil1 - - I :; ,---::
I
.,. "",-
;:)
,
~
I
~ __ I
I ;;
I
..
."
l'l
1 forU·!/lp[) rOTNTFR
1
1___________________________________ 1
1 f'1Ir.KW-\R'" POINTER
1
1
1 C F LL C (lLlJI~N
1_1 UU POW
1______ 1 OATA TYPE Ir.HhRACTER,NUMERIC,FOR.~lJLAJ
1_I CELL WIDTH
I
I CELL NA~E
I
I PR'JTf-CT INDICATOR
I
I
1
I
1
1
I
1
1
I
I
I
I
I
I
CEll CONTENTS (ASCII STRING, FORMULA, DATA RECORD CONTENTS"
I
I
"
..
(
\
\..
TAB LEO F
CON TEN T S
USER MANUAL
INTRODUCTION
---------------------------
1
THE DISPLAY SCREEN
---------------------
2
THE HELP FACILITY
----------------------
3
------~--------------------
4
CELL ENTRIES
ENTERING NUMBERS
ENTERING FORMULAS
--.---------------------
4
----------------------
5
ENTERING CHARACTER DATA
RANGES
----------------
/
---------------------------------
8
FUNCTIONS
COMMANDS
----------.--------------------
------------------------------- 10
CORRECTING MISTAKES
ERROR MESSAGES
GLOSSARY
9
-------------------- 12
------------------------- 13
------------------------------- 14
':'
1'
INTRODUCTION
-
This system is designed to make it as easy as possible for you~ the user,
to create your own individualized report.
With it you will be able to:
format
format
choose
choose
your
your
your
only
report headings
data
report headings
data that is relevant to you
'.
Once the template is created, it can be used over and over agaIn.
If you
want to run the report generator once a day, three times a day, or once a
week, the option is yours.
Or, you may choose to have the report
generator executed automatically.
If you need data sorted in a certain
manner, that option is yours, also.
If you don't want to see all the
data, but only data meeting a certain criteria, that option too is yours
using the search command.
Not only does this program provide user friendly menus ana pn:Jfr;p-':s, b· d there is also a help facility available if needed.
-
".
THE DISPLAY SCREEN
The display screen for the template generator consists of the Information
Section and the row and column indicators.
The information provided by
the Information Section consists of the current cell, the contents of the
-
current cell
(the formLtl a,
menu or prompts.
A1:
fie! dn2.fue,
or r:eadi ng),
the entr-'r,c
l.
~ ne,
and· the
An example follows:
@SUi1 (B2 •• F2)
Characters being entered or edited
Menu Ot- prompt
A
B
C
D
E
G
1
2
3
4
5
6
7
8
9
10
11
-
13
14
15
16
17
18
19
20
.
-
';'
THE HELP FACILITY
~\
The help facility is a reference manual on screen.
At any time you can
press the designated key to view the help screen.
The session will oe
temporarily suspended, remembering exactly where you are.
It clears the
worksheet from the dispay screen to display the help screen.
To retu~n
to the worksheet, press the designated return key once.
CELL ENTR I ES
4'
There are two different ways to enter data into a cell:
1. Type it yourself.
2. Retrieve data from a disk file.
There are three different types of data that can be entered
1. Character
in~o
a cell:
(as for a heading).
2. Numeric.
3. A formula.
To type an entry into a cell, move the cell pointer to the cell desired
and type the entry.
When finished press the return key.
The entry will
be stored in the current cell.
If something was already stored in the
cell, the new entry will replace it.
After pressing the return key, the entry will be checked for erro~s before
being stored in the current cell.
If an error is detected an error
message will appear in the prompt line above the worksheet.
ENTR I NG NUf-1BERS:
Numeric data must begin with 0 1 2 3 4 5 6 7 8 9 + - • $ ( @ or #.
The characters @ and # is used to tell the program that you will be
entering a sophisticated formula or numeric data from a file. The other
characters are self-explanatory numeric characters or numeric related
characters.
Here are the rules for entering numeric data:
1.
A number may begin with a digit, a plus or mInus sign,
decimal point, or a dollar sign.
2.
A number may end with a % to indicate percent.
words, the number will be divided by 100.
3.
A number cannot have more than one decimal point.
4.
A number cannot contain any commas or spaces when
entered.
NOTE: The above rules also apply to data from a file.
This does not mea~
that the variable name must begin ~'Jith one of these characte:--s.
Si.l:(:ly
enter # then the variable name to indicate numeric data.
If a formula is entered which is dependent upon a cell in which no entry
has yet been made, a string of E's will be displayed as the value of tha~
cell.
When the condition has been satisfied, the correct value will be
displayed.
-
a
'.5-
ENTERING FORMULAS
There are several ways to enter the same formula using this system.
iO
demonstrate, let's look at a simpl~ example.
For instance~ you might have
entered a column of numbers that you want to total.
One way to find the
total is to type in each value with a plus sign between each one (i.e.·
234+986+214+9450+754).
After pressing enter, the sum of these five
values would be displayed in the current cell.
Like numbers, :,a formula
may contain no space characters.
"
~
There is, however, an easier way to add these numbers together.
If, TOrexample, these values had been entered in column A, you could tell the
system where to find the values.
To do this enter +Al+A2+A3+A4+A5.
The
contents of column A would be totaled and after pressing enter, the sum
would be displayed in the current cell.
The plus sign preceding the
formula let's the system know that you are entering a formula.
~lnce the
cell addresses all begin with a letter, the formula would have been
accepted as character data by the system other-wise.
A formula,
like a number, must begin with one of these char-acter-s:
o
123 4 5 6 7 8 9 . + -
@ # $
Since our example adds a range of cells together-, we CO~lO use one of ~ne
special functions( An in depth ~iscussion of the range functions is
presented on page 8).
To add these five values together using the SUM
function you would enter the following:
@SUM(Al. • A5)
The result obtained is the same as the result from the two previous
e~{amples.
The following characters indicate arithmetic operations:
+ addition
subtraction
* multiplication
I division
Note: To enter a fraction,
you must use the slash -
as in 3/4.
Precedence of arithmetic operators:
In the following formulas,
right:
+AI-D3-A2
+C3/A2*B4
the operations are performed from left
~G
The order of operations can be altered by using parentheses:
-
+Al-(D3-A2)
+C3/(A2*B4)
Subtract the value of A2 fr~m D?
Th'?n
subtract that valup fr-cm ~h~ ",' cOl, 1. 'JE' c f Al.
;-~-; f
,..lu I tip] Y the '.. 2 J u e CJ f ('\ 2. b y
and divide thi= ff'c:,"lf- i.!'~Ci
.
'
-~'
':-
-
It is acceptable to nest parentheses, that is,
parentheses.
+Al+{C4*(D3-A2»
u~=
parentheses inside of
The other idea to keep in mind, is the idea of precedence.
Multiplication
and division are performed before addition and subtraction unLess
parentheses are used to alter that. ,Some examples are:
.
+G5+A7*IOO
Multiply the value of A7 by 100.
Then add the
result to the value of 65.
+1+1/4
Divide I by 4 and add that to I.
In other
:r!
t'\fords,
the nLlmOet-
none and a
qLlarter iJ
•
Negative numbers:
To enter a negative number (a number less than zero), simply begin the
number with a dash (-).
This holds true whether the number stands alone
or is in a formula.
For example:
_"":!'
-J
-AI means the negative of the value of Al
+Al--45 means subtract negative 45 from the value of At
The last e:-:ample illustrates fLlrther the idea of precedence.
"Take the
negative" is performed before "multiply" and "divide", ~'JhlCn ar-e pet-fot-med
before "add" and "subtract".
PO~'Jers:
The operation of exponentiation (or "raise to tile pO~Jer II) IS
before any other arithmetic operation.
To indicate exponentiation, the
(~)
is used (found on the six key).
+AIA6
Raise the value in cell Al to the sixth pO~'='Jer •
+14*AI 3
Raise the value in cell Al to the third n.-:I...
and
multiply the result by 14.
A
!L::. .....
r--'~'.~'
Review of precedence:
The arithmetic operators are listed below in order of precedence (from
highest to lowest)
E:<ponenti ati on
Negative
Multiplication ond Division
* and I
+ and
Addition and Subtraction
--
'.
ENTERING CHARACTER DATA
If the first character of an entry is not one of the numeric
the program will assume the entry is character data.
There are three special characters to let you choose how
will appear in the column.
These are:
~-~
to center a heading
~~~
to left-align a heading
~"~
to right-align a'heading
If you don~t enter one of these label-prefix characters,
default to left-aligned.
•
I·
•
In01Ca"LOrS.
your
heading~
the program will
NOTE:
If a heading begins with a number, a label-prefix must precede i t .
Otherwise, the entry will cause an error to occur.
".
-
ii'
RANGES:
-
A range is a group of one or more cells in a rectangular block.
Since_
range is a rectangle, you can identify it by naming the cells in two
diagonally-opposite corners.
To specify a range, type the cell address of any of the four corners~ then
type two periods, then the cell address of the corner diagonally-opposite
of the first one. E~-:amples are:
.,!
To indicate a range of cells thai include cells Al thrciugh A6, type
one of the following:
Al .. A6
A6 •. Al
To indic~te a range of cells that include cells Al through D5, typ~
one of the following:
AI.. D5
AS .• Dl
D5 .• Al
D1. .A5
To protect a cell or range:
1. On the menu choose the "/PHOTECT" command.
2. It ~'Ji 11 prompt you ~'Ji th "Enter range".
3. Enter the range you want to protect as
AI .. AlO
If you want to protect a single
is a range.
too,
Enter it as
AI. • Al
Any attempt to type over a protected cell will result in an error message,
accompanied by a beep, being displayed.
To unprotect a cell or range:
1. On the menu choose the "/Ui'JPROTECT" command.
2. It ~'Ji 11 prompt you ~'Ji th "Enter range".
3. Enter the range you want to unprotect as specified above.
Now you may type over any previously protected cell.
'.
-
FUNCTIONS:
,-
The following is a list of functions available with the software:
ADDITION
KEYllJORD -
FUNCTION -
SUN
The sum function is used to add two or more celiS
Dt-
FORi1AT
RESULT
numbers.
@SUr'1(celll,ceI12,ceI13,ceI14, . . . . . . ) , :
Adds the cont§nts of all cells indi~ated
and puts the result in the current cell.
AVER?mE
KEYl>JORD -
AVG
The average function is used to calculate the
average of two or more values.
@AVG(celll,ceI12,celI3,ceI14, . . . . . . )
Calculates the average of all values indicated and
places the result in the current cell.
FUNCTION FOF:t1AT
RESULT
MULTIPLICATION
KEYlI-JORD -
i1UL
The multiplication function 1S used to multiply
the contents of one or more cells or numbers.
together.
@MUL(celll,celI2,ceI13,cell,4, . . . . )
Multiplies the values specified ana places the
result in the current cell.
FUNCTION FOR!'1AT
RESULT
-
SQUARE ROOT
SQR
FUNCTION - The square root function is used
the square root of the contents of
number>.
!~SQR (cellI)
FOR!'r1AT
RESULT
Calculates the square root of the contents
and places the result in the current cell.
KEYl'JORD -
Some facts about functions:
Each function name begins ~Jith "I~"
Following the function name, you indicate the numbers to
be combined to produce the function's result.
These
"ar-guments" must be enclosed in parenthe'~es and sepai-ated by
commas.
For the rules on
You may specify a range as an argument.
specifying ranges, see page 8.
.
'
COMMANDS:
Commands are used to tell the program to perform certain tasks.
All
commands are listed in the menu, s~me giving way to another menu
I--'
Th.
I-I~ 1',
k.o.
h"-o'··Ofl
rlr!T!.oJ.~.·
i.".r-u-' ~h.I·-.
Con1:.al nl ng SU~lCOmmancs.
., ~ com-.. ,I:l;::c~'. . .,O'=>
,.,1.
~ ~
U~~.
t·.~I;
'-TT~
sections - those that apply to the template creation and those that apply
to the report generation.
L
••
----.J-
-_.
-
-
;,'
Template generator:
COMMAND: ITEMPLATE
PURPOSE: The template command consists of subcommands that
affect the format of the entire template.
SUBCDt1f'1ANDS:
IGLOBAL: Specifies evet-y cell to be affected.
Subcommands under global are:
IFIXED: for fixed point display of data.
ISCIENTIFIC: for scientific display of data.
ICOLUMN-WIDTH: Prompts you to allow a change to the widt!l of
a col ~lmn_
-
it
IPROTECT: Allows you to protect the entire
is completed.
protect on
ION:
IOFF: protect off - if after it is compl2~e
you need to change it, protection can
be removed.
IINSERT: Allows for the insertion o~ rows or columns.
Has
t~·JO subcommands:
ICOLUMN: for column insertion.
IROW: for row insertion.
IDELETE: Allows for the deletion of rows or columns.
Has
t\f-lo subcommands:
ICOLUMN: for column deletion.
IROW: for row deletion.
COMl"iAND: IRANGE
PURPOSE: The range command allo~s for the creation of ranges and
format of entire ranges.
SUBCOMMANDS:
IFIXED: for fixed point display of data within a range.
ISCIENTIFIC: for scientific display of data within a range.
IPERCENT: for percentile display of data within a range.
ILEFT-ALIGN: for left-alignment of data within a range.
ICENTER: for centering of data within a
IPROTECT: for type-over protection of a range.
IPROTECT-OFF: to remove type-over protection from a range~
INAME: to name a range that you will be using in the
•
report generator to search or sort on.
It is a qoO~
idea to name ranges the saffle
headings fo~reference to that column.
-
COMi1AND: /SA\lE
PURPOSE: The save command makes an exact ~opy of the progra~
saves it for future changes.
A temp l'lte ;:-~T~ul d al ~'~a\iS
saved after i t ' s creation.
11
Report generator:
IF I LE
PURPOSE: The file command is used to access the file to reLrleve
the n~eded data from it.
COi~lMAND:
CO!'1t1AND: IPRINT
PURPOSE: The print command is used to print the reporL.
COi'1!'1AND: I SORT
PURPOSE: The sort command is used to format the data In ~
sorted manner.
It has three subcommands:
IPRIMARY: To specify the primary sort key.
Under primary are two subcommands:
IASCENDING: to sort in an ascenolng order
IDESCENDING: to sort in a descending order
ISECONDARY: To specify the secondary sort key.
Under sEcondary are two subcommands:
IASCENDING: to sort in ascending oreer
IDESCENDING: to sort in descending oreer
ISTART: After you have selected a key or keys, the start
commano will tell the program to begin the sort.
-
cm'lNAND: ISEARCH
PURPOSE: The search command allows you to search for records that
meet certain criterion and view or print only those
records.
After entering the search command, the program
prompt you to enter the criterion.
In specifying the
criterion you may use the following relational
operators:
<
>
=
<=
)=
<>
meaning
meaning
meaming
meaning
less than
greater than
equal
less than or equal to
ineanirig greater than or equal to
meaning not equal to
You may also use the following logical operators:
#AND#,
#OR#, #NOT#
In some situations, several conditions
once:
lTl::!. ... ?
...........
7
apply
Select records whose shop number is either 03 or 07 .
Select records whose run seconds is greater than
and the minimum time stopped is less than 4.0.'
-
.
.
~=
-...:~ .......J
7t should be noted that the six logical op?rator~
"-...
.-:- ..
=, <=, >=, <> ) have a higher precedence than the th~eE
relational operators (#AND#~ #OR#, #NOT#).
Of the~e
three #NOT# has the higher precedence ~ith the other t~~
being equal.
That is, #AND and #OR# w~ll b~ pc~{~rmed
from left to right.
#NOT#(SHOP=04)
+SHOP=03#ORHSHOF=O(t!
12
CORRECTING MISTAKES:
If you realize you have made a mistake before you have presseo ~ne enter
.......
.
,
key, you can simply backspace to the error and start again.
i ne D2.c~-::space
will erase the last character you typed and any preceding characters that
you backspace to.
If the mistake goes unnoticed until after it has been entered into a cell,
simply move thE! cell pointer to the cell, then type another .. e::t~-y.
!::e
cell~s original contents will be repl~ced with the new entry.
-
".
-
';'
1~
ERROR MESSAGES
The following is a list of error messages the user might encounter:
-
FILE NOT FOUND
The f i 1 e, as entered, could not be found.
E:-:pl anati on:
Reenter the filename and check for correctness.
:,:
INVALID CELL ADDRESS - REENTER ADDRES,S
Explanation: This error would occur if the user entered ~
nonexistent cell address.
The cause would probably be a typographical
error.
INVALID RANGE ADDRESS - REENTER RANGE
Thi s error ~'Joul d OCCLU- if the user enter-ed a t-a·nge
E:-:planation:
address that is not valid or a cell address within the range address that
is not valid.
The cause could be a typographical error or trying to enter
a range address for something other than a range.
INVALID FORMULA - REENTER FORMULA
This error would occur if the user entered a
E:·:p I anati on:
De a.
The CaLtSe ~~oLll d
formula with unidentifiable operators.
typographical error.
DO YOU WANT TO PROCEED? YIN
INVALID FORMULA - DIVISION BY Z~RO.
Explanation:
This error would occur if the user attemoted to
divide by zero.
There might be several causes for this error.
If the
user entered a formula that used a field from a file as the deno~inator,
and the present value of that field was zero, this error would occur.
However, the user may wish to continue knowing that at some ti~e this
field will have valid numeric data in it.
Thus, he has the option of
continuing which will result in the cell or range containing the formula
to display the character E in the field.
If the user enters a formula which contains data from a cell that he has
not yet defined, this error would occur.
In this case also, he would want
to continue and the character E would be displayed in the cell or range
specified.
If the user accidentally tries to enter a formula containing division by
zero, he has the option not to proceed and can then enter new data.
_
PROTECTED CELL
Explanation:
This error would occur if the user tried to enter·
data into a cell that he had previously protected.
He can then go to th~
HELP screen or the user manual for instructions on how to unprotect the
cell if he wishes.
",
INVALID SORT KEY - REENTER KEY
E:-:planation:
This error would occur if the user attempted a
search on an undefined field.
This might be due to a typographical error.
-
':'
GLOSSARY:
Address:
The location of a particular cellon the template, referenced
by i t ' s column and row.
Examples of addresses: AI, G6, etc.
-
Argument: Information provided to a function.
Arguments, separated by
commas, are placed in parentheses following the function name.
An
argument may include one or more numbers, cell references, or sther
functions.
Examples of arguments:
@Sut1 (Bl .. BI0)
@SUM(@AVG(Bl .. B10)+@AVGCD5 •. D15»
Border:
The border is the area of the screen display wnlcn contains the
column letters (horizontal border) ~ and the rO~'J numbers <vertical border).
A single location on the worksheet, defined oy its column and row
Cell:
address.
Cell Pointer:
Column:
See "Poi ntet-" bel O~·J.
The vertical component of a cell address.
Command:
An instruction to the program to perform a task,
slash (I).
ISave is an example of a command.
-
preceded by a
It
The first three lines of the screen.
Information Section:
information about the current cell and the current Mode, your entries as'
they are typed or edited, menus and menu choice explanations, and command
prompts.
Criterion:
Cursor:
The "test condi tions" used in /Search Ot- ISort commands.
When making an entry the blinking underline is called a cursor.
Default:
The initial or original setting, which will be used unless you
specify a different one.
Disk or diskette:
The basic storage medium for microcomputers, alSO
called a floppy disk or diskette.
Disk drive:
The device into which disks are placed for use.
Display screen: See "Monitor" below.
Entry:
A general term for a number, formula or heading stored at a
location on the worksheet.
Error Message:
Messages which appear in the lower left corner
screen accompani ed by a beep from the computer ~'Jhen a rul e :-:as
violated or an impossible task has been requested.
-
OT
.
'"(:.,:e
Field:
A labeled column in the template or similar data in a file thae
has the same location for each record.
~
Fi Ie:
All
The way a
Format:
-
information stored on disk is kept in what is called files.
cell~s
contnents sre displayed on the screen.
Formula:
An instruction for the program to calculate a number.
Formulas are preceded by a (+) or (-) (as in the case: +81*Al), or
begin with a built-in function such as: @5UM(Al .. AI0)-Bl.
Function:
Built-in formulas to per-form particular calculations.
Functions are always preceded by an @ sign and take the form
@functioname(argl,arg2, •.• ,argN).
An alternative method of storage to the usual floppy DISK,
Hard disk:
often containing more than 20 times the storage capacity of _ SIngle
floppy.
The on-line reference manual.
Help:
Label-prefix Character:
A character used to indicate that the entry
being typed is a heading.
A label-prefix character must be used on
headings that begin with a number or with +, - , $, (, @, or #.
Logical Operators:
Logical operators are used to search for particular
data. For example, the statement @SEARCH(plant}15) will cause onlY thoie
plants whose number is larger than 15 to be displayed.
Main Memory:
-
Your computer's memory capacity.
A series of command choices which appear in the information
Menu:
....
seC~10n.
Menu Pointer:
Monitor:
See "Poi nter" bel O~·J.
The display screen of your computer.
Pointer:
The reverse-video bar which always highlights a cell anD/or
menu item on the template.
Also called the "Cell Pointer-I! or !'t'~enu
Pointer".
Prompt:
A message displayed during the execution of a command.
Protect:
A method of insuring against inadvertent modification of
specified cells.
Range:
A cell or rectangUlar group of cells on the template.
Ranqes
may be defined by typing the cell addresses of the opposite corner~ of t~E
range.
Recalculation:
~very time the report generator is invoked,
will be recalcul~ted using the most current version of the
Record:
A row in the template or related data in a file.
consists of one or more records.
-
Row:
The horizontal component of a cell's
addFE~s.
the template
~ile.
A -file
\
.
16
Screen:
The area on the monitor that allows you to view your template
or report.
Scrolling:
Value:
Moving through the temolate or report.
Any number or formula entered in the template.
-
".
-