@DATABASE "Leagues.guide"
@AUTHOR "Martin Wulffeld"

* $VER: Leagues.guide 0.997 (4.8.95)
* Copyright (C) 1995 Martin Wulffeld

@NODE Main "Leagues guide documentation"
@{b}
                               Leagues

                  Copyright © 1995 Martin Wulffeld

                         All Rights Reserved
@{ub}

 @{" Disclaimer       " LINK Disclaimer}   -   It's your fault...
 @{" License          " LINK License}   -   First read this

 @{" Installation     " LINK Installation}   -   The tedious process

 @{" Introduction     " LINK Introduction}   -   What IS this?

 @{" Usage            " LINK Usage}   -   At least read before complaining!
 @{" Menus            " LINK Menus}

 @{" How to register  " LINK HowToRegister}   -   How to support a broke SW programmer
 @{" Registered users " LINK RegisteredUsers}   -   Thank you for registering! :-)

 @{" Credits          " LINK Credits}   -   Don't bother.. I mean it..
 @{" History          " LINK History}   -   Once upon a time
 @{" Future           " LINK Future}   -   Things to do...
@ENDNODE

@NODE Disclaimer "Disclaimer"

    THERE IS NO WARRANTY FOR THE PROGRAMS, TO THE EXTENT PERMITTED BY
 APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAMS "AS IS" WITHOUT
 WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
 OF THE PROGRAMS IS WITH YOU.  SHOULD THE PROGRAMS PROVE DEFECTIVE, YOU
 ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

    IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
 WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
 REDISTRIBUTE THE PROGRAMS AS PERMITTED ABOVE, BE LIABLE TO YOU FOR
 DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL
 DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAMS
 (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
 INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF
 THE PROGRAMS TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER
 OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
@ENDNODE

@NODE License "License"

   This license applies to the product called `Leagues', a program
for the Amiga computer, published by Martin Wulffeld under the concepts
of SHAREWARE, and the accompanying documentation, example files and
anything else that comes with the original distribution. The terms
`program' and `Leagues' below, refer to this product. The licensee
is addressed as `you'.

   * You may copy and distribute verbatim copies of the program's
     executable code and documentation as you receive it, in any
     medium, provided that you conspicuously and appropriately publish
     only the original, unmodified program, with all copyright notices
     and disclaimers of warranty intact and including all the
     accompanying documentation, example files and anything else that
     came with the original.

   * You may not copy and/or distribute this program without the
     accompanying documentation and other additional files that came
     with the original.  You may not copy and/or distribute modified
     versions of this program.

   * You may not copy, modify, sublicense, distribute or transfer the
     program except as expressly provided under this license.  Any
     attempt otherwise to copy, modify, sublicense, distribute or
     transfer the program is void, and will automatically terminate
     your rights to use the program under this license.  However,
     parties who have received copies, or rights to use copies, from
     you under this license will not have their licenses terminated so
     long as such parties remain in full compliance.

   * By copying, distributing and/or using the program you indicate your
     acceptance of this license to do so, and all its terms and
     conditions.

   * Each time you redistribute the program, the recipient automatically
     receives a license from the original licensor to copy, distribute
     and/or use the program subject to these terms and conditions.  You
     may not impose any further restrictions on the recipients'
     exercise of the rights granted herein.

   * You may not disassemble, decompile, re-source or otherwise reverse
     engineer the program.

   * You may use the program for a period of up to 2 weeks for
     evaluation. After that, you have to register or quit using the
     program.

   * You agree to cease distributing the program and data involved if
     requested to do so by the author.

   * You may charge a fee to recover distribution costs.  The fee for
     diskette distribution may not be more than the cost to obtain a
     public domain diskette from Fred Fish.
@ENDNODE

@NODE Introduction "Introduction to Leagues"

 @{b}Leagues is Copyright © 1995 Martin Wulffeld. All Rights Reserved.@{ub}

  Leagues was coded by Martin Wulffeld.


  It uses the ReqTools library which is copyright © Nico François.

  Leagues requires Kickstart 2.04. Workbench 2.1 is required for locale
  support.


 @{b}What is Leagues@{ub}

  Leagues is program which helps you to record valuable information about
  teams in a league. I mostly use it for keeping track of my favourite
  teams results during a season but it is designed in such a way that you
  can also use it for predicting the next match results. There is no
  specific function for that but by using the different functions and
  comparing team data with eachother you can somehow predict the outcome
  of the next matches.
@ENDNODE

@NODE Installation "Installation"

 @{b}Installation@{ub}

  To install Leagues click on the install icon.

  You can of course also install Leagues manually. If you wish to do so
  you simply have to place unpack.library and reqtools.library in LIBS:
  and the catalog for your language in LOCALE:Catalogs/<language/
@ENDNODE

@NODE Usage "How to use Leagues"

 @{b}Usage@{ub}

   In all listviews you can use the up and down cursors to scroll
   through the entries. Pressing shift and up/down will move 2 entries
   and alt will move to either the top or bottom. Pressing return on
   an entry acts as a doubleclick.
  
   All windows can be canceled/closed with a press on the escape key
   except the main window if Leagues is on a public screen.

   The main listview shows the leagues which you have loaded/created. By
   pressing return or double clicking on one of them the @{"team window" LINK Usage_TeamWindow}
   will open.
@ENDNODE  

@NODE Menus "The menus"

 @{b}Menus@{ub}

  @{" Project     " LINK MENU_Project}
  @{" Leagues     " LINK MENU_Leagues}
  @{" Preferences " LINK MENU_Preferences}
@ENDNODE  

@NODE MENU_Project "Project menu"

 @{b}The project menu@{ub}

  @{" About   " LINK MI_About}

  @{" Quit... " LINK MI_Quit}
@ENDNODE  

@NODE MENU_Leagues "Leagues menu"

 @{b}The leagues menu@{ub}

  @{" Load... " LINK MI_LoadLeagues}
  @{" Save... " LINK MI_SaveLeagues}
@ENDNODE

@NODE MENU_Preferences "Preferences menu"

 @{b}The preferences menu@{ub}

  @{" Edit... " LINK MI_Edit}

  @{" Save... " LINK MI_SavePrefs}
@ENDNODE

@NODE MI_About "Project/About"

 Some information on Leagues.
@ENDNODE

@NODE MI_Quit "Project/Quit"

 Quits Leagues. If preferences have been changed and you haven't saved them
 a requester will inform you about that and give you the possibility to
 either Save them, Quit or (only in some cases) Cancel quit.
@ENDNODE

@NODE MI_LoadLeagues "Leagues/Load..."

 Load a leagues file. If there already are some leagues loaded they will
 not be removed but instead the loaded leagues will be added to the list.
@ENDNODE

@NODE MI_SaveLeagues "Leagues/Save..."

 Save all the leagues in the listview to a file.
@ENDNODE

@NODE MI_Edit "Preferences/Edit..."

 @{b}Screen Mode@{ub}

  Select the screen mode you want Leagues to be in.

  The screen is public so you can put other windows on to Leagues. The
  name of the screen is 'Leagues'.

 @{b}Font@{ub}

  The font which will be used for everything besides listviews.

 @{b}List view font@{ub}

  This font is used in all listviews.

 @{b}Palette@{ub}

  Well, kind a speaks for it self doesn't it...

 @{b}Scroller width@{ub}

  The width of the scrollers in listviews.
@ENDNODE

@NODE MI_SavePrefs "Preferences/Save"

 Save preferences to "ENV:Leagues/Leagues.prefs" and "ENVARC:Leagues/Leagues.prefs".
@ENDNODE

@NODE Usage_TeamWindow "Team window"

 In the team window there are as in the main window 5 gadgets in the top and
 a listview.

  @{" Add    " LINK TW_Add}
  @{" Remove " LINK TW_Remove}
  @{" Sort   " LINK TW_Sort}
  @{" Up     " LINK TW_Up}
  @{" Down   " LINK TW_Down}

 Other functions are located in the menu. @{" Team window menus " LINK TWMenus}

 By double clicking on a team you can enter a new result. @{" Add result " LINK TW_AddResult }

 Pressing return while a team is highlighted you will get the team
 information window. @{" Team information " LINK TW_TeamInformation}

 Above the listview there are a number of characters and a single word :)
 They are common abbrevations and you should be familiar with most of
 them.

  P    - Position
  Name - Name of team

  M    - Matches played
  W    - Total number of won matches
  D    - Total number of drawn matches
  L    - Total number of lost matches
  F    - Total number of goals scored (for)
  A    - Total number of goals conceived (against)
  P    - Total number of points

  W    - Number of won matches home
  D    - Number of drawn matches home
  L    - Number of lost matches home
  F    - Number of goals scored home (for)
  A    - Number of goals conceived home (against)
  P    - Number of points gained by home matches

  W    - Number of won matches away
  D    - Number of drawn matches away
  L    - Number of lost matches away
  F    - Number of goals scored away (for)
  A    - Number of goals conceived away (against)
  P    - Number of points gained by away matches
@ENDNODE

@NODE TW_Add "Add team"

 Before you can start adding results to the league you must have created all
 the teams in the league. Just type the name in the requester and the team is
 now in the league. To remove it press @{"Remove" LINK TW_Remove} before any
 matches have been played.
@ENDNODE

@NODE TW_Remove "Remove team"

 Removes the highlighted team. You can only remove a team if there haven't
 been played any matches yet.
@ENDNODE

@NODE TW_Sort "Sort teams"

 Sort the teams after points. This is actually just a shortcut for the
 menuitem with the exact same function :)
@ENDNODE

@NODE TW_Up "Move a team up"

 Moves the highlighted team upwards in the list. Use this when you f.x.
 want to compare two teams with eachother. Move the two teams towards
 eachother so it's easier to compare their data.
@ENDNODE

@NODE TW_Down "Move a team down"

 Moves the highlighted team downwards in the list. Use this when you f.x.
 want to compare two teams with eachother. Move the two teams towards
 eachother so it's easier to compare their data.
@ENDNODE

@NODE TW_AddResult "Add a result"
@ENDNODE

@NODE TWMenus "Team window menus"

 @{b}The team window menus@{ub}

  @{" Teams         " LINK TWMENU_Teams}
  @{" Sort          " LINK TWMENU_Sort}
  @{" Miscellaneous " LINK TWMENU_Miscellaneous}
@ENDNODE  

@NODE TWMENU_Teams "Teams menu"

 @{b}Teams menu@{ub}

  @{" Form...                 " LINK TWMI_Form}
  @{" Form home...            " LINK TWMI_FormHome}
  @{" Form away...            " LINK TWMI_FormAway}

  @{" Average goals scored... " LINK TWMI_AverageGoalsScored}
@ENDNODE  

@NODE TWMENU_Sort "Sort menu"

 @{b}Sort menu@{ub}

  @{" Name               " LINK TWMI_Name}
  @{" Points             " LINK TWMI_Points}
  @{" Points home        " LINK TWMI_PointsHome}
  @{" Points away        " LINK TWMI_PointsAway}
  @{" Wins               " LINK TWMI_Wins}
  @{" Wins home          " LINK TWMI_WinsHome}
  @{" Wins away          " LINK TWMI_WinsAway}
  @{" Drawn              " LINK TWMI_Drawn}
  @{" Drawn home         " LINK TWMI_DrawnHome}
  @{" Drawn away         " LINK TWMI_DrawnAway}
  @{" Losses             " LINK TWMI_Losses}
  @{" Losses home        " LINK TWMI_LossesHome}
  @{" Losses away        " LINK TWMI_LossesAway}
  @{" Goals for          " LINK TWMI_GoalsFor}
  @{" Goals for home     " LINK TWMI_GoalsForHome}
  @{" Goals for away     " LINK TWMI_GoalsForAway}
  @{" Goals against      " LINK TWMI_GoalsAgainst}
  @{" Goals against home " LINK TWMI_GoalsAgainstHome}
  @{" Goals against away " LINK TWMI_GoalsAgainstAway}
@ENDNODE

@NODE TWMENU_Miscellaneous "Miscellaneous menu"

 @{b}Miscellaneous menu@{ub}

  @{" Results...          " LINK TWMI_Results}
  @{" Team information... " LINK TWMI_TeamInformation}

@ENDNODE

@NODE TWMI_Form "Teams/Form"

 @{b}Form@{ub}

  Use this function when you want to get a picture of how a team is
  currently doing. A requester appears where you'll have to type the
  number of matches back Leagues should look at when generating the form
  table. F.x. if you typed 5 you will get a table which represents how the
  league would look like if each team had only played 5 matches. A teams
  form usually varies during a season so this is a very important feature
  to have.
@ENDNODE

@NODE TWMI_FormHome "Teams/Form home"

 @{b}Form home@{ub}

  See @{" Form " LINK TWMI_Form} for a more detailed description of this feature.

  A form table is only generated for the last x number of home matches.
@ENDNODE

@NODE TWMI_FormAway "Teams/Form away"

 @{b}Form away@{ub}

  See @{" Form " LINK TWMI_Form} for a more detailed description of this feature.

  A form table is only generated for the last x number of away matches.
@ENDNODE

@NODE TWMI_AverageGoalsScored "Teams/Average goals scored"

 @{b}Average goals scored@{ub}

  Here you will be able to see the average goals scored by each team in
  the league. There's a column for total, home and away.
@ENDNODE

@NODE TWMI_Name "Sort/Name"

 @{b}Sort by name@{ub}

  Sort the teams in the league alphabetically.
@ENDNODE

@NODE TWMI_Points "Sort/Points"

 @{b}Sort by points@{ub}

  Sort the teams in the league by points. If two teams have the same
  number of points the team with the best score difference will be moved
  upwards. If they also have the same score difference nothing will
  happen.
@ENDNODE

@NODE TWMI_PointsHome "Sort/Points home"

 @{b}Sort by points home@{ub}

  Sort the teams in the league by points home. If two teams have the same
  number of points the team with the best score difference will be moved
  upwards. If they also have the same score difference nothing will
  happen.
@ENDNODE

@NODE TWMI_PointsAway "Sort/Points away"

 @{b}Sort by points away@{ub}

  Sort the teams in the league by points away. If two teams have the same
  number of points the team with the best score difference will be moved
  upwards. If they also have the same score difference nothing will
  happen.
@ENDNODE

@NODE TWMI_Wins "Sort/Sort by wins"

 @{b}Sort by wins@{ub}

  Sort the teams in the league by the total number of wins.
@ENDNODE

@NODE TWMI_WinsHome "Sort/Wins home"

 @{b}Sort by home wins@{ub}

  Sort the teams in the league by the number of wins home.
@ENDNODE

@NODE TWMI_WinsAway "Sort/Wins away"

 @{b}Sort by away wins@{ub}

  Sort the teams in the league by the number of wins away.
@ENDNODE

@NODE TWMI_Drawn "Sort/Drawn"

 @{b}Sort by drawn@{ub}

  Sort the teams in the league by the total number of drawn matches.
@ENDNODE

@NODE TWMI_DrawnHome "Sort/Drawn home"

 @{b}Sort by drawn home@{ub}

  Sort the teams in the league by the number of drawn home matches.
@ENDNODE

@NODE TWMI_DrawnAway "Sort/Drawn away"

 @{b}Sort by drawn away@{ub}

  Sort the teams in the league by the number of drawn away matches.
@ENDNODE

@NODE TWMI_Losses "Sort/Losses"

 @{b}Sort by losses@{ub}

  Sort the teams in the league by the total number of losses.
@ENDNODE

@NODE TWMI_LossesHome "Sort/Losses home"

 @{b}Sort by losses home@{ub}

  Sort the teams in the league by the number of lost matches home.
@ENDNODE

@NODE TWMI_LossAway "Sort/Losses away"

 @{b}Sort by losses away@{ub}

  Sort the teams in the league by the number of lost matches away.
@ENDNODE

@NODE TWMI_GoalsFor "Sort/Goals for"

 @{b}Sort by goals for@{ub}

  Sort the teams in the league by the total number of goals scored.
@ENDNODE

@NODE TWMI_GoalsForHome "Sort/Goals for home"

 @{b}Sort by goals for home@{ub}

  Sort the teams in the league by the number of goals scored home.
@ENDNODE

@NODE TWMI_GoalsForAway "Sort/Goals for away"

 @{b}Sort by for away@{ub}

  Sort the teams in the league by the number of goals scored away.
@ENDNODE

@NODE TWMI_GoalsAgainst "Sort/Goals against"

 @{b}Sort by goals against@{ub}

  Sort the teams in the league by the total number of goals conceived.
@ENDNODE

@NODE TWMI_GoalsAgainstHome "Sort/Goals against home"

 @{b}Sort by goals against home@{ub}

  Sort the teams in the league by the number of goals conceived home.
@ENDNODE

@NODE TWMI_GoalsAgainstAway "Sort/Goals against away"

 @{b}Sort by goals against away@{ub}

  Sort the teams in the league by the number of goals conceived away.
@ENDNODE

@NODE TWMI_Results "Results..."

 Will show the highlighted teams results in a new window. The first result
 is the team's first match and so on.
@ENDNODE

@NODE TWMI_TeamInformation "Team information"

 Information on the highlighted team will be shown in a window. The first
 information is the teams best and worst matches. Then the average of
 goals scored total, home and away and finally the form of the team
 expressed via 'w','d','l','W',D','L' for respectively home wins, home
 draws, home defeats, away wins, away draws, away defeats.
@ENDNODE

@NODE HowToRegister "HowToRegister"

 @{b}How to register Leagues@{ub}

  To register, FIRST fill out the registration form which is included in
  the distribution as 'Leagues.regform' and send it to me to one of the
  addresses below.

  THEN there are 2 ways you can send the registration fee to me.

  1. The first and easiest way (in my opinion) is to send cash to my
     snailmail address below.

     But keep in mind that it is at your own risk if you do that. I cannot
     be responsible for lost letters. But just remember to wrap a piece
     of paper around the cash so the possibly corrupt mailman is unable
     to see what's inside the envelope.

     The registration fee may be one of the following:

       50,- DKR (Danish kroners)
       70,- SKR (Swedish kroners)
       60,- NKR (Norwegian kroners)
       15,- DEM (German D-mark)
        5,- GBP (British pound sterling)
       10,- USD (US-Dollars)
       40,- FFR (French francs)

       + 1 errorfree disk + a little bit of extra money to cover postage
       and the return envelope.

       A 2DD disk is approx. 1,- USD and postage is approx. 1.5,- inside
       Europe and approx. 2,- USD outside. So there goes approx. 20% of
       the registration fee to cover post & postage for those who forget
       to enclose the disk and stamps.

     @{b}OR@{ub}

       60,- DKR
       80,- SKR
       70,- NKR
       18,- DEM
        6,- GBP
       12,- USD
       50,- FFR

  2. Transfer the equivalent of 60,- DKR to my bank:

      Unibank
      Praestoe Afdeling
      Adelgade 76
      4720 Praestoe
      Denmark

      Name: Martin Wulffeld

      Reg. number:    0047
      Account number: 4482-600-846

 ===========================================================================

  ASAP on receipt of your registration I will send a personalized keyfile
  to you. But things take time so please allow up to 4 weeks for delivery.

  Put the keyfile in your L: assign.

  You may not sell or give away the keyfile.

  The keyfile will make all future locked features available to you.

 ===========================================================================

  * Snail mail: Martin Wulffeld
                Odensevej 121, 2 TV
                4700 Naestved
                Denmark

  * E-Mail:     wulffeld@datashopper.dk

  * Fidonet:    2:236/25.4

  * Amiganet:   39:141/132.4

  * Phone:      +45 (55) 77 01 37
@ENDNODE

@NODE Credits "Guilty parties"

 @{b}Credits@{ub}

  Thanks goes to the following people who were involved with the
  'Leagues' project:

  (In no particular order)

   - It could be you standing here! :)
@ENDNODE

@NODE History "History"

 @{b}History@{ub}

  Abbreviations:
 
   SUG = Suggestion by
   BUG = Bug reported by

  Version:

   @{"  0.99 " LINK VERS_099}
   @{" 0.997 " LINK VERS_0997}
@ENDNODE

@NODE VERS_099 "Version 0.99  :  17.7.1995"

 First public release.

 I released this BETA version for two reasons. I wanted to get it out a
 couple of weeks before the football seasons start around the world and
 secondly I hope there are a lot of users who will give me feedback on
 this BETA version. In other words: BETAtesters needed!

 At the time of writing I'm the only one who has tested Leagues so I'll
 cross my fingers and hope for the best if I were you :)
@ENDNODE

@NODE VERS_0997 "Version 0.997  :  4.8.1995"

 @{b}Changes@{ub}

  * Start points feature removed. It wasn't important for the operation of
    Leagues.

 @{b}Bug fixes@{ub}

  * LOTS! :)
@ENDNODE

@NODE Future "The future of Leagues..."

 @{b}Future@{ub}

  The following are features I intend to add to Leagues in the future.

   * First of all fix the remaining bugs/hits and make it 1.0 :)
   * Adjustable spacing between the teams in the team window.
   * Have it load a specific leagues file each time.
   * Graphical statistics.

  If you have any other ideas whatsoever please tell me... 
@ENDNODE