Listing 2. StarTrek.guide AmigaGuide Help File


@database StarTrek.guide
@remark HELP FILE FOR STAR TREK VIDEO COLLECTION DATABASE
@author Randy C. Finch
@(c) "Copyright - 1993 RKA Productions"
@$VER: StarTrek.guide 1.0 (10/30/93)
@wordwrap
@font topaz.font 8
@index "StarTrek_MasterIndex"


@node "Main" "Star Trek Database General Info"
Star Trek Database General Info

This program handles a database specifically designed for cataloging
video tapes containing Star Trek television shows.  It has entry
fields for the type of show (Original, The Next Generation, or Deep
Space 9), the show's title, year, episode, tape number, show number,
and a description.  New entries can be made easily and old ones can
be deleted.  You can sort the database by tape number and show
number and print the database to a Hewlett-Packard LaserJet 4
printer in a useful format.  The data can be saved and loaded to
disk, also.

For an index of help topics, click on the Index button at the top
of this window.
@endnode


@node "StarTrek_MasterIndex" "Star Trek Database Master Index"
Star Trek Database Master Index

@{" General Info " link "Main"}

Fields:

@{" Show         " link "StarTrek_Show"}
@{" Title        " link "StarTrek_Title"}
@{" Year         " link "StarTrek_Year"}
@{" Episode #    " link "StarTrek_Episode"}
@{" Tape #       " link "StarTrek_TapeNum"}
@{" Show #       " link "StarTrek_ShowNum"}
@{" Description  " link "StarTrek_Description"}

Buttons:

@{" EditAdd      " link "StarTrek_EditAdd"}
@{" Prev         " link "StarTrek_Prev"}
@{" Next         " link "StarTrek_Next"}
@{" Del          " link "StarTrek_Del"}
@{" Sort         " link "StarTrek_Sort"}
@{" Print        " link "StarTrek_Print"}
@{" Load         " link "StarTrek_Load"}
@{" Save         " link "StarTrek_Save"}
@{" Help         " link "StarTrek_Help"}
@endnode


@node "StarTrek_Show" "Star Trek Database: Show Field"
Star Trek Database: Show Field

This field allows you to input a three-letter code that represents
which Star Trek show is being referenced.  Currently there are only three
codes that make any sense.

   ORG = Original show with William Shatner, et. al.
   TNG = The Next Generation with Patrick Stewart, et. al.
   DS9 = Deep Space Nine with Avery Brooks, et. al.

Other codes may be added as new Star Trek series are produced.
@endnode


@node "StarTrek_Title" "Star Trek Database: Title Field"
Star Trek Database: Title Field

This field allows you to input the title of the Star Trek show.
The title is normally shown when the show returns from the opening
credits and commercials.
@endnode


@node "StarTrek_Year" "Star Trek Database: Year Field"
Star Trek Database: Year Field

This field allows you to input the year the show aired.  You may choose
to use the original year if you know it or the year in which you recorded
the show.

This field is a text field rather than an integer field because if you
do not know the exact year of the show, you may want to enter something
like <1989, Old, etc.
@endnode


@node "StarTrek_Episode" "Star Trek Database: Episode # Field"
Star Trek Database: Episode # Field

This field allows you to input the episode number of the show for the year
it was shown.  You may base this on the original year it was shown if you
know it.  Otherwise, you can use the year in which you recorded the show.
@endnode


@node "StarTrek_TapeNum" "Star Trek Database: Tape # Field"
Star Trek Database: Tape # Field

This field allows you to input a number for the tape on which this show was
recorded.  The tape number should be written on the tape label for easy
reference.
@endnode


@node "StarTrek_ShowNum" "Star Trek Database: Show # Field"
Star Trek Database: Show # Field

This field allows you to input a number representing the location of the
show on the selected tape number.  For example, if you use a 2-hour tape
in SLP mode, the show number can be 1 through 6 (assuming all shows are one
hour long).

You can only enter a number from 1 to 8.
@endnode


@node "StarTrek_Description" "Star Trek Database: Description Field"
Star Trek Database: Description Field

This field allows you to input a description of the show.  It can contain
any text you like.  You may find that you need to abbreviate some words to
prevent overrunning the field.
@endnode


@node "StarTrek_EditAdd" "Star Trek Database: Edit/Add Rollo Button"
Star Trek Database: Edit/Add Rollo Button

This button allows you to toggle between edit mode and add mode.

When you switch to edit mode, the first record of the database is
displayed.  You may edit any existing entries, but you cannot add new ones.

The @{" Prev         " link "StarTrek_Prev"} and @{" Next         " link "StarTrek_Next"}
buttons can be used to step forward and backward through the database.
The current record number is shown in the window's title bar.

When you switch to add mode, some fields are cleared and all additional
input is added to the database.  The record will be added when you press
the RETURN key with the cursor in the Description field.  The Prev, Next,
Del, and Sort buttons are not functional in this mode.  The next record
to be added is shown in the window's title bar.
@endnode


@node "StarTrek_Prev" "Star Trek Database: <- Button"
Star Trek Database: <- Button

When this button is pressed, the previous record is displayed.  If the
first record is the current record, then the last record will be
displayed.

This button is not functional when in Add mode.
@endnode


@node "StarTrek_Next" "Star Trek Database: -> Button"
Star Trek Database: -> Button

When this button is pressed, the next record is displayed.  If the last
record is the current record, then the first record will be displayed.

This button is not functional when in Add mode.
@endnode


@node "StarTrek_Del" "Star Trek Database: Del Button"
Star Trek Database: Del Button

When this button is pressed, the currently displayed record is deleted.

This button is not functional when in Add mode.
@endnode


@node "StarTrek_Sort" "Star Trek Database: Sort Button"
Star Trek Database: Sort Button

When this button is pressed, the database will be sorted by tape number.
Within each tape number, the show number will be sorted.  A sort must be
performed before you print the database if you want the output to make
any sense.

This button is not functional when in Add mode.
@endnode


@node "StarTrek_Print" "Star Trek Database: Print Button"
Star Trek Database: Print Button

When this button is pressed, the database will be printed in a format such
that the for each tape number, the shows are listed by show number.  It
appear as follows:

Tape Tape#

ShowNum. Title1     Show  Year-Episode#  Description
           .
           .
           .
           
Eight tapes will be listed per page.  The output will currently only work
with a Hewlett-Packard LaserJet 4 (and perhaps other HP LaserJets).  You
must sort the database before printing if you want it to look right.
@endnode


@node "StarTrek_Load" "Star Trek Database: Load Button"
Star Trek Database: Load Button

When this button is pressed, a standard Amiga file requester is displayed.
You can then select the file you want to load and press the OK button.  You
can cancel the operation by pressing the Cancel button.
@endnode


@node "StarTrek_Save" "Star Trek Database: Save Button"
Star Trek Database: Save Button

When this button is pressed, a standard Amiga file requester is displayed.
You can then select the path and filename to which you want to save the
database and press the OK button.  You can cancel the operation by pressing
the Cancel button.
@endnode


@node "StarTrek_Help" "Star Trek Database: Help Buttons"
Star Trek Database: Help Buttons

The ? button:

This is the small button in the lower right hand corner of the screen.
When clicked on, it toggles on and off.  When it is on, you can click
on fields and buttons on the screen to obtain help.  To go back to
normal database entry mode simply turn the help button off.

The Star Trek button:

This is the image button at the top of the screen with the words Star Trek.
It can be clicked on at any time, whether the help button is on or off,
to obtain an index of help topics.

The Help key:

If the help key is pressed on the keyboard while no fields are selected,
then an index of help topics will be displayed.
@endnode