home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Crawly Crypt Collection 1
/
crawlyvol1.bin
/
apps
/
database
/
tcos
/
tcos.doc
< prev
next >
Wrap
Text File
|
1989-07-08
|
14KB
|
330 lines
TCOS v1.2
---------
(c) Perfect Evolution 1989
By Matthew P. Aubury (15)
User Documentation
------------------
1 Introduction
1.1 Getting Started
2 Window Handling
3 Desk Menu
4 System Menu
4.1 Loading/Saving
4.2 Join System
4.3 New System
4.4 System Status
4.5 System Tree
5 Data Menu
5.1 Editing
5.2 Reformat Text
5.3 Erase Text
5.4 Import Graphics
5.5 Assign Image
6 Card Menu
6.1 Goto Card
6.2 Rename Card
6.3 Copy Card
6.4 Add Button
6.5 Replace Button
6.6 Delete Button
7 Appendix
1. Introduction
-----------------
'TCOS' is an information storage system which will run
on any Atari ST in either medium or high resolution. It is
designed to allow you to structure information in a logical
way which allows you to access data quickly and efficiently.
Data is arranged in a series of 'cards', which contain
either text or graphics. Areas of the cards are designated as
'buttons', which, when clicked on with the mouse pointer,
bring up further cards. In this way, a branching tree of
cards is formed, which allows the information to be
structured in a sensible way.
This technique lends itself to many uses: referencing
information, diagnostic systems, expert systems, and even
teaching programs.
1.1 Getting Started
--------------------
To start the program, double click on the file
'TCOS.PRG', which will load and display a GEM menu and an
'UNTITLED' window. The menu options and window handling are
discussed later, but for an example, move the mouse pointer
up to the 'SYSTEM' heading, and click on the 'LOAD SYSTEM'
option. When the file selection box appears, select the file
'DEMO.SYS'. A new card will appear, with some information on.
Click within any one of the three red boxes and another card
will appear, and so on. To go back a card, click on the close
window character at the top left-hand corner of each card.
2. Window Handling
--------------------
a) By clicking on the close window icon in the top left of
each card, you can go back to the parent of each card, unless
you are on the root card.
b) By clicking and holding the icon at the bottom right of
the card, you can resize the window. If there is any text in
the window, you are given the choice to reformat the text, or
not. If you don't, each of the lines will be cut off at the
new size (which can be useful if you are dealing with a
table).
c) If there are any buttons on the window, they will be
displayed as lines (red if you are in medium resolution). By
clicking within any one of these you will bring up the next
card.
3. Desk Menu
--------------
Under the desk menu is the choice 'Information on TCOS',
which displays the copyright message, and any desk accesories
you have installed. All these function as normal.
4. System Menu
----------------
The 'System' menu deals with general operations
regarding the the structure of the data.
4.1 Loading and Saving
-----------------------
a) Clicking on the 'Load System' option brings up a file
selection box. Choosing a system will load it, erasing the
system currently in memory.
b) Clicking on the 'Save System' option will store the
current system on disk. The name of the root (first) card
will be the same as the filename, so changing the filename
will change the name of the first card, and vice versa.
4.2 Join System
----------------
This option allows you to build much larger systems than
the usual, by dividing them over a number of disk files. This
is advisable if you intend to write very large systems, for
two reasons: First, if you write many cards you may run out
of memory, and secondly, as each system is loaded in one
piece, a very large system would take too long to load,
whereas it is easier just to load the piece you require. You
may have a base system, with just a few options, each of
which loaded a new system.
When using the option, you are given a file selection
box, from which you choose the system which will be joined.
The program then deletes the current card, having designated
it as a 'join' card and returns you to the parent card. Thus,
whenever you bring up the card, the new system selected is
loaded into memory. Be warned, however, that loading the new
system deletes the current one, so save any changes before
testing the option.
4.3 New System
---------------
The 'New System' option allows you to completely delete
all cards and information in memory. An alert box is
displayed to prevent you erasing the system accidentally.
4.4 System Status
------------------
Clicking on the 'System Status' option will bring up a
small dialog box, detailing the amount of free memory, of
free and used cards and free disk space.
4.5 System Tree
----------------
The 'System Tree' is a useful feature allowing you to
see the structure of the system. Clicking on it draws a tree
of lines, labelled at each intersection with the name of the
each card. Using this you can trace the root to each card,
and see how many cards are dependant on any given card.
5. Data Menu
--------------
The 'Data' menu deals with the contents of each card, be
they text or graphics.
5.1 Edit Text
--------------
Once selected, the edit text option allows you to add
and delete text, as with any other text editor (though it
lacks many of the refinements of a word processor, it is
quite adequate.) The keys which are operational, apart from
ordinary character keys are:
BACKSPACE : Delete the character behind the cursor
DELETE : Delete the current character
INSERT : Insert a line
CONTROL-DELETE : Delete a line
RETURN : Perform a carriage return
ESCAPE : Leave the editor.
CURSOR KEYS : As usual.
5.2 Reformat Text
------------------
Often when typing pure text, a word will be broken over
two lines, so the 'Reformat Text' option counters this by
forcing broken words onto the following line.
5.3 Erase Text
---------------
Selecting this option deletes all text on a page, or
removes any assigned graphics, so you can start typing in
information afresh.
5.4 Import Graphics
--------------------
This option brings up a file selection box which allows
you to choose from any '.PI3' files (Degas,High Resolution
pictures) you have. If you are running in medium resolution,
the picture will be converted and displayed. Grab a section
of the picture by clicking and holding at the top-left hand
corner of the section and releasing over the bottom-right
hand corner. Then select a filename for this new '.IMG' file.
It can be incorporated into the system with the next option.
5.5 Assign Image
-----------------
Selecting this, then selecting an '.IMG' file just
created with the above option, deletes any text on the
current card, and replaces it with the picture. Rather that
take up large amounts of memory, each new picture is loaded
as needed, but this obviously requires the disk with the
picture on to be in the drive at all times. Buttons can be
added to any picture in the usual way, (see chapter 6), and
you can thus build a visual reference system.
6. Card Menu
--------------
The 'Card' menu deals with all card and button options,
such as renaming and finding cards, and adding and erasing
buttons.
6.1 Goto Card
--------------
When you select this option, type in the name of the
card you wish to view, and the program will jump straight to
it, without going through each card individually. This can be
especially useful when you see the card you wish on the
'System Tree' option, and wish to find it immediately.
6.2 Rename Card
----------------
Each card is assigned an individual name, and this can
be changed under this option. This name is shown on the
'System Tree' option, so it is useful if you give each card a
sensible name, either when you create it, or by using this
option.
6.3 Copy Card
--------------
If you require a card to be duplicated across, select
this option and type in the name of the card you wish to copy
from. The program then copies the text and size of the card
to your current card. Be warned, however, as the buttons may
not fit correctly onto the new sized card, and may spill over
the edges. Correct this with the 'Replace Button' option.
6.4 Add Button
---------------
When you select this option, use the pointer to draw a
button onto the card, by clicking and holding with the left-
hand button on the top-left hand corner of the button, and
releasing on the bottom-right. If you selected the option by
mistake, press the right-hand button.
Then type in a name for the new card. If you press
return, the card will be assigned an individual number. Now
you have a new, clear card, which can be accessed by clicking
on the new button.
6.5 Replace Button
-------------------
If you misplace a button, or you edit the text and the
button is no longer in the correct position, this option
allows you to relocate it. Click on the button you wish to
replace, which will then disappear, then draw a new button on
in the normal way (see section 6.4). All connections, text
and other buttons remain intact.
6.6 Delete Button
------------------
Clicking on the button you wish to delete, this option
brings up and alert box, warning that when you delete a
button in this manner, you delete the card which follows on
from the button, and all buttons and cards which follow on
from that - so it is a DANGEROUS option, and should only be
used where you are sure what you are doing!
7. Appendix
-------------
TCOS was written in GFA Basic v1.0 over a period of
about a month, and then compiled with the GFA Basic Compiler
v2.02.
One final note; though the program is designed to be
foolproof - there is actually no such thing, and so problems
can arise. I hope I have included enough options, and
documented them well enough to allow you to rectify any
problems, but no insurance is given for loss of work!