Club Amiga de Montreal - CAM/CAM_CD_1.iso/files/462a.lha/SiliconSecretary_v1.3/HELP/SS.HELP.pp/SS.HELP

Text File | 1991-01-05 | 17KB | 358 lines

Documentation for SILICON SECRETARY
From Allen Maroney  (GEnie: A.MARONEY)
Version 1.3   December 15, 1990

<< FOR MORE HELP CLICK ON THE WINDOW IN QUESTION AND PRESS THE HELP KEY >>

The SILICON SECRETARY (SS) program was written for my use and I therefore
make no warranty, or promise that it will do anything useful for you.  If
you have  any trouble with the program let me know - I really want it to
be bug-free.  Getting a copy of your data file to me is extremely helpful!

**** GENERAL STUFF

   Although this program does everything by the book and thus multitasks
well, it does eat up a considerable amount of memory.  It will therefore
not work on a 512K Amiga.  Some memory is taken from the system as needed.
If you attempt something and nothing happens you may be out of memory.
Since windows require memory to open I cannot always display what's wrong.
All of the testing was on an A1000 ('85 vintage) with 1.5 meg and a A500
with 1 meg.  The program with a full team loaded (62 Bowlers) eats about
500K.

   Hard drive users should (but it isn't necessary) make a subdirectory
for your league data files.  Then use the ASSIGN command to assign it
'SS:'.  This way the 'SS' button on the file requester will get you
there fast.  example:  'ASSIGN SS: DH0:BOWLING'  if you have a BOWLING
subdirectory on drive DH0:

   LIMITS:  I have imposed the following limits:
            TEAMS.........................  100
            BOWLERS PER TEAM..............   50

   This seems reasonable.  The memory needed is dynamically allocated.
Translated, You could run out of memory during a run.  If this should
happen the program should tell you.  Try closing any windows or other
programs that are running.  If you still don't have enough memory reboot
and CTRL-D to stop the startup-sequence from loading the workbench.
Then type 'SS' from the CLI.  If you STILL don't have enough memory,
you need to buy some.

   Once a data file is created it's size shouldn't change unless you
add or delete bowlers and/or teams.  What will take up more disk space
is the text files that SS creates.

**** PURPOSE

  To help most bowling league secretaries keep league statistics.
  (Geez that sounds so easy!)

**** SUMMARY

   Startup:  Workbench users may click the SS icon or a data file icon
             created by SS.  Clicking the data file will result in that
             data file being loaded, the TEAM EDITOR window opening and
             the next available week being displayed and awaiting scores.

             CLI users enter 'SS' or 'SS datafile' for the same results
             as workbench.  Entering 'SS ?' will display a small template.

   The MENU choices are available except when another action is taking
place (such as RUNNING the program).

   The main area you'll be working in is the TEAM EDITOR.  This a window
that allows you to enter and edit the individual scores of each team
member.  Creating new teams & bowlers is also done from this window.

   The LEAGUE INFORMATION window is where you need to enter information
concerning the entire league.  Usually this will remain constant
throughout the season.

   The DISPLAY window allows you to see the final output with or without
a copy going to the printer or a disk file.  This text file may also be
viewed in the DISPLAY window (or any word processor).  Usually text that
has scrolled out of view may be scrolled back with the mouse by clicking
the Arrows or moving the proportional gadget on the DISPLAY window.  If
you see a row of number signs "#####..." that is where a page break will
be.  This prints as a form feed.

   The PERSONAL window allows you to keep addresses, phone numbers,
league office (if any) and social security numbers for individual
bowlers.  This information may be used to generate a phone list,
mailing labels and end-of-season reports for ABC/WIBC.

  In both the TEAM EDITOR window and the PERSONNEL window you may search
for a bowler by entering a QUESTION MARK at the beginning of the name.
The search string only needs enough characters to be unique.  This is not
a case sensitive search and the search string may be contained anywhere in
 the name.  This search starts at team #0, bowler 1.  If a match is found
it will be displayed, otherwise the original bowler will be redisplayed.

**** HELPFUL TIP

  After all of your league's scores and wins/loses are entered for the
week and you have run the data check the following:

  - Compare the team totals from the bottom of the recap sheet against the
    team pin count at the bottom of the printout.  If a score does not
    match check to make sure that you entered the scores correctly in the
    program and then re-add the team's recap sheet.  If things still don't
    add up right make sure that the entering average was entered for the
    bowler.

  - Also check the number of wins/loses to make sure that you didn't
    triple-click a gadget in error.  Usually (excluding forfeitures) if
    your league has 12 teams the WON columns will add up to 24. (This
    is assuming that a game = 1 point and there are 3 games and total)

  These checks are quick and can prevent an embarrassing situation later
in the season.

**** DETAILED EXPLANATION

The MENU choices are:

PROJECT - CLEAR
          This clears all of the teams (and bowlers) FOREVER.  The program
          will ask you if you really want to carry out this action.

PROJECT - RUN
          RUN ALL
          Once all data is in the program this begins the process of
          turning it into something useful.  The program may warn you
          if it encounters an error or lack of data.  This option
          calculates from week 1 through the last week.  The last week
          is determined by the last week that has WINS/LOSES entered
          for team 1. The ESC key will ask you if you want to stop the run.

          RUN PARTIAL WEEKS
          Same as RUN ALL except that it runs from week 1 through the
          current week.  The current week is determined by week number
          displayed at the top of the columns for entering scores in
          the TEAM EDITOR.  You will be asked to verify this selection.
          The ESC key will ask you if you want to stop the run.

PROJECT - OPEN
          This loads a SILICON SECRETARY data file that you have already
          saved.

PROJECT - SAVE
          This will save the current data with the name you supply.  If
          the data already has a name it will save it over the old data.
          You may also notice a disk gadget located at the upper left
          of the Team Editor & League Editor windows.  If selected (dark)
          the program will save the current file every 50 entries.

PROJECT - SAVE AS
          The same as SAVE except it will ALWAYS ask you for a file name.
          This allows you to save a file under two names.  The most often
          use for this is backing up your data file (STRONGLY RECOMMENDED!)

PROJECT - IMPORT
          Imports personal data (addresses, phone numbers, social security
          numbers) from a previously saved data file into the current file.
          This is useful in leagues that carry over the same bowlers from
          season to season.  The program will ask you if you want to
          import the old averages as entering averages for the current
          season.  Respond YES to this ONLY if the data file that you're
          importing from was from the previous season of the same league.
          Only bowlers that had at least had as many games as are in
          the Qualifying Games fields of the League Editor will be used.
          This is usually 21 games.
          Any personal information already entered for a bowler will not
          be altered by this function.

PROJECT - EXPORT
          EXPORT comes in two flavors (subitems).
          The first is RAW DATA which dumps all of your data to a file
          in ASCII (text) format.  This can be useful if someone wants
          to see all of their scores.  This format may also be used to
          import data into many popular spreadsheets.  Once the data is
          in the spreadsheet you're on your own!
          The program will run the data to guarantee that it is current,
          although you will not see this happening except on the
          Team Editor Window.

          The second is BOWLMASTER format.  BOWLMASTER will be a separate
          program that will calculate statistics for individual bowlers
          far beyond the level of SILICON SECRETARY.  Although currently
          on the back burner, I plan on making it a reality.
          SS will run the data to guarantee that it is current, although
          you will not see this happening except on the Team Editor Window.

PROJECT - ABOUT
          Tells you the Silicon Secretary revision that you are using and
          where to send your shareware fee. :-)

PROJECT - HELP
          Displays this file.

PROJECT - RULES
          This looks for a text file in the HELP subdirectory named
          'SS.RULES'.  If you have your league's rules as a text file
          stick it here for online help.  The rules need to have a return
          at the end of every line and no more than 75 characters in a
          line for proper display.  The current limit is 2000 lines,
          providing that you have the free memory.

PROJECT - QUIT
          This should only be used when it's time to go bowling.

OUTPUT  - PRINTER
          Output except the online help (this) will be dumped to your
          printer if this is checked.  The status (checked or not) is saved
          with the data file.

OUTPUT  - FILE
          Most Output except the online help (this) will be saved as text
          if this is checked.  If a path is supplied in the LEAGUE EDITOR
          window it will go to the path specified.  The status (checked or
          not) is saved with the data file.

OUTPUT  - ICON
          If you want your files to have icons check this.  If you start SS
          from the workbench this will be checked.  If you started it from
          the CLI it will not.  There are currently five different icons
          created by SS, depending on the file.  The status (checked or
          not) is saved with the data file.

OUTPUT  - OPTS - AWARDS
          If this is checked a list of individual awards will be printed
          after the program is run.  This is printed by bowler and includes
          any awards earned in weeks prior to and including the current
          week.  Only bowlers that have bowled AT LEAST 21* Games are
          counted. (*Actual weeks are set up in QUALIFY WEEKS gadget)
          Many of these awards are dependent on the bowler's average
          which follows the award in brackets.  The following awards
          are checked for:

          --- ABC ---                     --- WIBC ---
          300 Game                        300 Game
          299 Game                        299 Game
          298 Game                        298 Game
           75 Pins O.A. Game [-149]       250 Game [170+]
          100 Pins O.A. Game              225 Game [146-169]
          Triplicate                      200 Game [-145]
          150 Pins O.A. Series            3-200 Games
          550 Series [-149]               Triplicate
          700 Series                       75 Pins O.A. Game
          800 Series                      150 Pins O.A. Series
          2-300 Games                     675 Series [170+]
                                          650 Series [146-169]
                                          500 Series [-145]

          Some awards can't be checked for, like a Dutch 200.  So sorry.

OUTPUT  - OPTS - SCHEDULE
          If you are using ABC/WIBC schedules this will print the
          following week's schedule with the weekly team report.
          Currently leagues with between 3 and 20 teams may take
          advantage of this.  If you have too few or too many teams this
          menu item will be disabled.

OUTPUT  - OPTS - SHORT FORM
          If this is checked a shorter version (with less information)
          will be printed when you RUN the data.

OUTPUT  - OPTS - SUB LIST
          This will display the floating subs' names, average and phone
          numbers after the main printout.  This could be handy for teams
          that need a bowler at the last minute.  As with most of the
          printout options, bowlers named 'BLIND' or with names beginning
          with '#' will not be displayed.

OUTPUT  - OPTS - RECAP FORM
          If checked this will append recap forms to the end of the RUN.
          The teams will be scheduled according to the ABC/WIBC schedule.
          If you have too few or too many teams this menu item will be
          disabled.

OUTPUT  - OPTS - RECAP LIST
          If checked this will append a list of teams that are bowling
          against each other (using the internal schedule).  This is
          similar to the recap form without the grid and the teams are
          next to each other.  If you have too few or too many teams
          this menu item will be disabled.

OUTPUT  - OPTS - NEWSLETTER
          Prints up a summary of the week's highlights suitable to turn
          in for a company or church newsletter.  This is designed to be
          a starting point for a article, not the finished product.

WINDOWS - LEAGUE EDITOR
          TEAM EDITOR
          VIEW DISPLAY
          PERSONAL DATA
          These menu options open the window named or, if it's already
          open, bring it to the front.  All or no windows may be opened at
          any time.  You are only limited by your Amiga's memory.
          For a more detailed description about the gadgets and abilities
          of LEAGUE EDITOR, TEAM EDITOR and PERSONAL DATA open that window
          and press the HELP key on your keyboard.

          There are two windows that you MUST close before doing anything
          else.  They are the file requester and the error/info requester.

          VIEW DISPLAY
          The VIEW DISPLAY window allows you to view the output before or
          during printing.  Most operations may be Stopped or Paused with
          with the 'S' or 'P' gadget on the lower right hand side of the
          window.  Once the text has stopped scrolling up you may use the
          arrows or proportional gadget to look at any part of the display.
          The PRT gadget will cause the currents of the display to be
          dumped to the printer regardless of whether or not the printer
          option from the menu is selected.  The Stop and Pause work during
          printing.  If you close this window and reopen it the last text
          displayed will still be available.  While new text is being
          displayed the ESC key will function the same as the 'S' gadget.

PERSONAL- PRINT LABELS
          Displays an address list of all bowlers suitable for tractor
          feed mailing labels (1" labels).  This may be printed either
          alphabetized or as-entered (by team).  Only bowlers with an
          address entered will be printed

PERSONAL- PRINT ADDRESSES
          List each bowler by name, address and phone on one line each
          across the page.  Bowlers are alphabetized by last name.

PERSONAL- PRINT PHONE LIST
          Displays an alphabetized (by last name) phone list.  If PRINTER
          and/or FILE is selected it will go there also.  The phone list
          will print in two columns.

PERSONAL- PRINT EOS REPORT
          End-Of-Season Report.  This will display a report containing
          Bowler's name, Social Security number, pincount, games bowled
          and final average.  This report is acceptable to the ABC/WIBC
          as of 1989 season.  The program will run the data to guarantee
          that it is current.

OTHER   - CLEAR WINS
          If you click the WIN/LOSS/TIE/FORFEIT gadget in the EDITOR WINDOW
          by mistake (ie- wrong week) this will reset it to the unselected
          QUESTION MARK.  For more information press HELP while the
          TEAM EDITOR window is active.

OTHER   - CHG CASE
          Allows you to select either MAKE CLC or MAKE CAPS.  MAKE CLC
          will make all team and bowler names Caps & lower case.  MAKE CAPS
          will turn them into all caps.  The routine was already in the
          program for internal use so I decided to make it available via
          a menu.

OTHER   - CHANGE COLOR
          It changes the screen's colors (supprise!).  Currently you're
          stuck with the four color sets that I selected.  I'm not crazy
          about the red either.  The color that you select is saved with
          your data file.  This may be handy if you're working with more
          than one league.  The colors are Gray, Red, Blue, and Brown.

OTHER   - AVG. BEEP
          Some recap forms have the bowler's average next to the first
          game.  It's easy to enter the average as the first game if
          you're not very careful (I've done it).  If this is checked
          the screen will flash (DisplayBeep) whenever a bowler's average
          is entered as a score.  This is only a reminder to be careful.
          Other than the flash nothing else happens.